Skip to content

Commit 7bbc1c3

Browse files
NoelStephensUnityunity-renovate[bot]EmandM
authored
fix: Avoid throwing exception when using NetworkList without a NetworkManager [Up-port] (#3504)
<!-- Replace this block with what this PR does and why. Describe what you'd like reviewers to know, how you applied the engineering principles, and any interesting tradeoffs made. Delete bullet points below that don't apply, and update the changelog section as appropriate. --> <!-- Add short version of the JIRA ticket to the PR title (e.g. "feat: new shiny feature [MTT-123]") --> Up-port of #3502 Fixes #2539 ## Changelog - Added: `LocalClientCannotWrite` function to co-locate the shared functionality - Fixed: Ensure that the `NetworkManager` exists before attempting to access the `LocalClientId` ## Testing and Documentation - No tests have been added. <!-- Uncomment and mark items off with a * if this PR deprecates any API: ### Deprecated API - [ ] An `[Obsolete]` attribute was added along with a `(RemovedAfter yyyy-mm-dd)` entry. - [ ] An [api updater] was added. - [ ] Deprecation of the API is explained in the CHANGELOG. - [ ] The users can understand why this API was removed and what they should use instead. --> ## Backport <!-- If this is a backport: - Add the following to the PR title: "\[Backport\] ..." . - Link to the original PR. If this needs a backport - state this here If a backport is not needed please provide the reason why. If the "Backports" section is not present it will lead to a CI test failure. --> Backported in #3502 --------- Co-authored-by: unity-renovate[bot] <120015202+unity-renovate[bot]@users.noreply.github.com> Co-authored-by: Emma <[email protected]>
1 parent 13abd46 commit 7bbc1c3

File tree

6 files changed

+26
-15
lines changed

6 files changed

+26
-15
lines changed

‎com.unity.netcode.gameobjects/CHANGELOG.md‎

Lines changed: 1 addition & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -10,6 +10,7 @@ Additional documentation and release notes are available at [Multiplayer Documen
1010

1111
### Fixed
1212

13+
- Fixed `NullReferenceException` on `NetworkList` when used without a NetworkManager in scene. (#3503)
1314
- Fixed issue where `NetworkClient` could persist some settings if re-using the same `NetworkManager` instance. (#3491)
1415
- Fixed issue where a pooled `NetworkObject` was not resetting the internal latest parent property when despawned. (#3491)
1516
- Fixed issue where the initial client synchronization pre-serialization process was not excluding spawned `NetworkObject` instances that already had pending visibility for the client being synchronized. (#3488)

‎com.unity.netcode.gameobjects/Runtime/Messaging/Messages/NetworkVariableDeltaMessage.cs‎

Lines changed: 3 additions & 3 deletions
Original file line numberDiff line numberDiff line change
@@ -144,9 +144,9 @@ public void Serialize(FastBufferWriter writer, int targetVersion)
144144
var startingSize = writer.Length;
145145
var networkVariable = NetworkBehaviour.NetworkVariableFields[i];
146146
var shouldWrite = networkVariable.IsDirty() &&
147-
networkVariable.CanClientRead(TargetClientId) &&
148-
(networkManager.IsServer || networkVariable.CanClientWrite(networkManager.LocalClientId)) &&
149-
networkVariable.CanSend();
147+
networkVariable.CanClientRead(TargetClientId)
148+
&& (networkManager.IsServer ||
149+
(networkVariable.CanWrite && networkVariable.CanSend()));
150150

151151
// Prevent the server from writing to the client that owns a given NetworkVariable
152152
// Allowing the write would send an old value to the client and cause jitter

‎com.unity.netcode.gameobjects/Runtime/NetworkVariable/AnticipatedNetworkVariable.cs‎

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -217,7 +217,7 @@ public void Anticipate(T value)
217217
m_LastAnticipationCounter = m_NetworkBehaviour.NetworkManager.AnticipationSystem.AnticipationCounter;
218218
m_AnticipatedValue = value;
219219
NetworkVariableSerialization<T>.Duplicate(m_AnticipatedValue, ref m_PreviousAnticipatedValue);
220-
if (CanClientWrite(m_NetworkBehaviour.NetworkManager.LocalClientId))
220+
if (CanWrite)
221221
{
222222
AuthoritativeValue = value;
223223
}

‎com.unity.netcode.gameobjects/Runtime/NetworkVariable/Collections/NetworkList.cs‎

Lines changed: 6 additions & 6 deletions
Original file line numberDiff line numberDiff line change
@@ -428,7 +428,7 @@ public IEnumerator<T> GetEnumerator()
428428
public void Add(T item)
429429
{
430430
// check write permissions
431-
if (!CanClientWrite(m_NetworkManager.LocalClientId))
431+
if (CannotWrite)
432432
{
433433
LogWritePermissionError();
434434
return;
@@ -455,7 +455,7 @@ public void Add(T item)
455455
public void Clear()
456456
{
457457
// check write permissions
458-
if (!CanClientWrite(m_NetworkManager.LocalClientId))
458+
if (CannotWrite)
459459
{
460460
LogWritePermissionError();
461461
return;
@@ -493,7 +493,7 @@ public bool Contains(T item)
493493
public bool Remove(T item)
494494
{
495495
// check write permissions
496-
if (!CanClientWrite(m_NetworkManager.LocalClientId))
496+
if (CannotWrite)
497497
{
498498
LogWritePermissionError();
499499
return false;
@@ -542,7 +542,7 @@ public int IndexOf(T item)
542542
public void Insert(int index, T item)
543543
{
544544
// check write permissions
545-
if (!CanClientWrite(m_NetworkManager.LocalClientId))
545+
if (CannotWrite)
546546
{
547547
LogWritePermissionError();
548548
return;
@@ -578,7 +578,7 @@ public void Insert(int index, T item)
578578
public void RemoveAt(int index)
579579
{
580580
// check write permissions
581-
if (!CanClientWrite(m_NetworkManager.LocalClientId))
581+
if (CannotWrite)
582582
{
583583
throw new InvalidOperationException("Client is not allowed to write to this NetworkList");
584584
}
@@ -610,7 +610,7 @@ public T this[int index]
610610
set
611611
{
612612
// check write permissions
613-
if (!CanClientWrite(m_NetworkManager.LocalClientId))
613+
if (CannotWrite)
614614
{
615615
LogWritePermissionError();
616616
return;

‎com.unity.netcode.gameobjects/Runtime/NetworkVariable/NetworkVariable.cs‎

Lines changed: 5 additions & 5 deletions
Original file line numberDiff line numberDiff line change
@@ -128,7 +128,7 @@ public virtual T Value
128128
get => m_InternalValue;
129129
set
130130
{
131-
if (m_NetworkManager && !CanClientWrite(m_NetworkManager.LocalClientId))
131+
if (CannotWrite)
132132
{
133133
LogWritePermissionError();
134134
return;
@@ -162,7 +162,7 @@ public bool CheckDirtyState(bool forceCheck = false)
162162
var isDirty = base.IsDirty();
163163

164164
// A client without permissions invoking this method should only check to assure the current value is equal to the last known current value
165-
if (m_NetworkManager && !CanClientWrite(m_NetworkManager.LocalClientId))
165+
if (CannotWrite)
166166
{
167167
// If modifications are detected, then revert back to the last known current value
168168
if (!NetworkVariableSerialization<T>.AreEqual(ref m_InternalValue, ref m_InternalOriginalValue))
@@ -245,7 +245,7 @@ public override bool IsDirty()
245245
{
246246
// If the client does not have write permissions but the internal value is determined to be locally modified and we are applying updates, then we should revert
247247
// to the original collection value prior to applying updates (primarily for collections).
248-
if (!NetworkUpdaterCheck && m_NetworkManager && !CanClientWrite(m_NetworkManager.LocalClientId) && !NetworkVariableSerialization<T>.AreEqual(ref m_InternalValue, ref m_InternalOriginalValue))
248+
if (!NetworkUpdaterCheck && CannotWrite && !NetworkVariableSerialization<T>.AreEqual(ref m_InternalValue, ref m_InternalOriginalValue))
249249
{
250250
NetworkVariableSerialization<T>.Duplicate(m_InternalOriginalValue, ref m_InternalValue);
251251
return true;
@@ -307,7 +307,7 @@ public override void ReadDelta(FastBufferReader reader, bool keepDirtyDelta)
307307
{
308308
// If the client does not have write permissions but the internal value is determined to be locally modified and we are applying updates, then we should revert
309309
// to the original collection value prior to applying updates (primarily for collections).
310-
if (m_NetworkManager && !CanClientWrite(m_NetworkManager.LocalClientId) && !NetworkVariableSerialization<T>.AreEqual(ref m_InternalOriginalValue, ref m_InternalValue))
310+
if (CannotWrite && !NetworkVariableSerialization<T>.AreEqual(ref m_InternalOriginalValue, ref m_InternalValue))
311311
{
312312
NetworkVariableSerialization<T>.Duplicate(m_InternalOriginalValue, ref m_InternalValue);
313313
}
@@ -349,7 +349,7 @@ public override void ReadField(FastBufferReader reader)
349349
{
350350
// If the client does not have write permissions but the internal value is determined to be locally modified and we are applying updates, then we should revert
351351
// to the original collection value prior to applying updates (primarily for collections).
352-
if (m_NetworkManager && !CanClientWrite(m_NetworkManager.LocalClientId) && !NetworkVariableSerialization<T>.AreEqual(ref m_InternalOriginalValue, ref m_InternalValue))
352+
if (CannotWrite && !NetworkVariableSerialization<T>.AreEqual(ref m_InternalOriginalValue, ref m_InternalValue))
353353
{
354354
NetworkVariableSerialization<T>.Duplicate(m_InternalOriginalValue, ref m_InternalValue);
355355
}

‎com.unity.netcode.gameobjects/Runtime/NetworkVariable/NetworkVariableBase.cs‎

Lines changed: 10 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -381,6 +381,16 @@ public bool CanClientWrite(ulong clientId)
381381
}
382382
}
383383

384+
/// <summary>
385+
/// Returns true if the current <see cref="NetworkManager.LocalClientId"/> can write to this variable; otherwise false.
386+
/// </summary>
387+
internal bool CanWrite => m_NetworkManager && CanClientWrite(m_NetworkManager.LocalClientId);
388+
389+
/// <summary>
390+
/// Returns false if the current <see cref="NetworkManager.LocalClientId"/> can write to this variable; otherwise true.
391+
/// </summary>
392+
internal bool CannotWrite => m_NetworkManager && !CanClientWrite(m_NetworkManager.LocalClientId);
393+
384394
/// <summary>
385395
/// Returns the ClientId of the owning client
386396
/// </summary>

0 commit comments

Comments
 (0)