Update naming, add CanWrite method

EmandM · EmandM · commit d33a784ff348 · 2025-06-13T17:27:25.000-04:00
diff --git a/com.unity.netcode.gameobjects/Runtime/Messaging/Messages/NetworkVariableDeltaMessage.cs b/com.unity.netcode.gameobjects/Runtime/Messaging/Messages/NetworkVariableDeltaMessage.cs
@@ -145,7 +145,7 @@ public void Serialize(FastBufferWriter writer, int targetVersion)
                 var networkVariable = NetworkBehaviour.NetworkVariableFields[i];
                 var shouldWrite = networkVariable.IsDirty() &&
                     networkVariable.CanClientRead(TargetClientId) &&
-                    (networkManager.IsServer || networkVariable.CanClientWrite(networkManager.LocalClientId)) &&
+                    (networkManager.IsServer || networkVariable.CanWrite() &&
                     networkVariable.CanSend();
 
                 // Prevent the server from writing to the client that owns a given NetworkVariable
diff --git a/com.unity.netcode.gameobjects/Runtime/NetworkVariable/AnticipatedNetworkVariable.cs b/com.unity.netcode.gameobjects/Runtime/NetworkVariable/AnticipatedNetworkVariable.cs
@@ -217,7 +217,7 @@ public void Anticipate(T value)
             m_LastAnticipationCounter = m_NetworkBehaviour.NetworkManager.AnticipationSystem.AnticipationCounter;
             m_AnticipatedValue = value;
             NetworkVariableSerialization<T>.Duplicate(m_AnticipatedValue, ref m_PreviousAnticipatedValue);
-            if (CanClientWrite(m_NetworkBehaviour.NetworkManager.LocalClientId))
+            if (CanWrite())
             {
                 AuthoritativeValue = value;
             }
diff --git a/com.unity.netcode.gameobjects/Runtime/NetworkVariable/Collections/NetworkList.cs b/com.unity.netcode.gameobjects/Runtime/NetworkVariable/Collections/NetworkList.cs
@@ -428,7 +428,7 @@ public IEnumerator<T> GetEnumerator()
         public void Add(T item)
         {
             // check write permissions
-            if (LocalClientCannotWrite())
+            if (CannotWrite())
             {
                 LogWritePermissionError();
                 return;
@@ -455,7 +455,7 @@ public void Add(T item)
         public void Clear()
         {
             // check write permissions
-            if (LocalClientCannotWrite())
+            if (CannotWrite())
             {
                 LogWritePermissionError();
                 return;
@@ -493,7 +493,7 @@ public bool Contains(T item)
         public bool Remove(T item)
         {
             // check write permissions
-            if (LocalClientCannotWrite())
+            if (CannotWrite())
             {
                 LogWritePermissionError();
                 return false;
@@ -542,7 +542,7 @@ public int IndexOf(T item)
         public void Insert(int index, T item)
         {
             // check write permissions
-            if (LocalClientCannotWrite())
+            if (CannotWrite())
             {
                 LogWritePermissionError();
                 return;
@@ -578,7 +578,7 @@ public void Insert(int index, T item)
         public void RemoveAt(int index)
         {
             // check write permissions
-            if (LocalClientCannotWrite())
+            if (CannotWrite())
             {
                 throw new InvalidOperationException("Client is not allowed to write to this NetworkList");
             }
@@ -610,7 +610,7 @@ public T this[int index]
             set
             {
                 // check write permissions
-                if (LocalClientCannotWrite())
+                if (CannotWrite())
                 {
                     LogWritePermissionError();
                     return;
diff --git a/com.unity.netcode.gameobjects/Runtime/NetworkVariable/NetworkVariable.cs b/com.unity.netcode.gameobjects/Runtime/NetworkVariable/NetworkVariable.cs
@@ -128,7 +128,7 @@ public virtual T Value
             get => m_InternalValue;
             set
             {
-                if (LocalClientCannotWrite())
+                if (CannotWrite())
                 {
                     LogWritePermissionError();
                     return;
@@ -162,7 +162,7 @@ public bool CheckDirtyState(bool forceCheck = false)
             var isDirty = base.IsDirty();
 
             // A client without permissions invoking this method should only check to assure the current value is equal to the last known current value
-            if (LocalClientCannotWrite())
+            if (CannotWrite())
             {
                 // If modifications are detected, then revert back to the last known current value
                 if (!NetworkVariableSerialization<T>.AreEqual(ref m_InternalValue, ref m_InternalOriginalValue))
@@ -245,7 +245,7 @@ public override bool IsDirty()
         {
             // 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
             // to the original collection value prior to applying updates (primarily for collections).
-            if (!NetworkUpdaterCheck && LocalClientCannotWrite() && !NetworkVariableSerialization<T>.AreEqual(ref m_InternalValue, ref m_InternalOriginalValue))
+            if (!NetworkUpdaterCheck && CannotWrite() && !NetworkVariableSerialization<T>.AreEqual(ref m_InternalValue, ref m_InternalOriginalValue))
             {
                 NetworkVariableSerialization<T>.Duplicate(m_InternalOriginalValue, ref m_InternalValue);
                 return true;
@@ -307,7 +307,7 @@ public override void ReadDelta(FastBufferReader reader, bool keepDirtyDelta)
         {
             // 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
             // to the original collection value prior to applying updates (primarily for collections).
-            if (LocalClientCannotWrite() && !NetworkVariableSerialization<T>.AreEqual(ref m_InternalOriginalValue, ref m_InternalValue))
+            if (CannotWrite() && !NetworkVariableSerialization<T>.AreEqual(ref m_InternalOriginalValue, ref m_InternalValue))
             {
                 NetworkVariableSerialization<T>.Duplicate(m_InternalOriginalValue, ref m_InternalValue);
             }
@@ -349,7 +349,7 @@ public override void ReadField(FastBufferReader reader)
         {
             // 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
             // to the original collection value prior to applying updates (primarily for collections).
-            if (LocalClientCannotWrite() && !NetworkVariableSerialization<T>.AreEqual(ref m_InternalOriginalValue, ref m_InternalValue))
+            if (CannotWrite() && !NetworkVariableSerialization<T>.AreEqual(ref m_InternalOriginalValue, ref m_InternalValue))
             {
                 NetworkVariableSerialization<T>.Duplicate(m_InternalOriginalValue, ref m_InternalValue);
             }
diff --git a/com.unity.netcode.gameobjects/Runtime/NetworkVariable/NetworkVariableBase.cs b/com.unity.netcode.gameobjects/Runtime/NetworkVariable/NetworkVariableBase.cs
@@ -383,14 +383,14 @@ public bool CanClientWrite(ulong clientId)
         }
 
         /// <summary>
-        /// Catches if the current <see cref="NetworkManager.LocalClientId"/> is not valid to write to this variable.
+        /// Returns true if the current <see cref="NetworkManager.LocalClientId"/> can write to this variable; otherwise false.
         /// </summary>
-        /// <returns>false if the current <see cref="NetworkManager.LocalClientId"/> can write to this variable, true otherwise</returns>
-        [MethodImpl(MethodImplOptions.AggressiveInlining)]
-        internal bool LocalClientCannotWrite()
-        {
-            return m_NetworkManager && !CanClientWrite(m_NetworkManager.LocalClientId);
-        }
+        internal bool CanWrite => m_NetworkManager && CanClientWrite(m_NetworkManager.LocalClientId);
+
+        /// <summary>
+        /// Returns false if the current <see cref="NetworkManager.LocalClientId"/> can write to this variable; otherwise true.
+        /// </summary>
+        internal bool CannotWrite => m_NetworkManager && !CanClientWrite(m_NetworkManager.LocalClientId);
 
         /// <summary>
         /// Returns the ClientId of the owning client

Original file line number	Diff line number	Diff line change
`@@ -217,7 +217,7 @@ public void Anticipate(T value)`
`217`	`217`	`m_LastAnticipationCounter = m_NetworkBehaviour.NetworkManager.AnticipationSystem.AnticipationCounter;`
`218`	`218`	`m_AnticipatedValue = value;`
`219`	`219`	`NetworkVariableSerialization<T>.Duplicate(m_AnticipatedValue, ref m_PreviousAnticipatedValue);`
`220`		`- if (CanClientWrite(m_NetworkBehaviour.NetworkManager.LocalClientId))`
	`220`	`+ if (CanWrite())`
`221`	`221`	`{`
`222`	`222`	`AuthoritativeValue = value;`
`223`	`223`	`}`
Original file line number	Diff line number	Diff line change
`@@ -428,7 +428,7 @@ public IEnumerator<T> GetEnumerator()`
`428`	`428`	`public void Add(T item)`
`429`	`429`	`{`
`430`	`430`	`// check write permissions`
`431`		`- if (LocalClientCannotWrite())`
	`431`	`+ if (CannotWrite())`
`432`	`432`	`{`
`433`	`433`	`LogWritePermissionError();`
`434`	`434`	`return;`
`@@ -455,7 +455,7 @@ public void Add(T item)`
`455`	`455`	`public void Clear()`
`456`	`456`	`{`
`457`	`457`	`// check write permissions`
`458`		`- if (LocalClientCannotWrite())`
	`458`	`+ if (CannotWrite())`
`459`	`459`	`{`
`460`	`460`	`LogWritePermissionError();`
`461`	`461`	`return;`
`@@ -493,7 +493,7 @@ public bool Contains(T item)`
`493`	`493`	`public bool Remove(T item)`
`494`	`494`	`{`
`495`	`495`	`// check write permissions`
`496`		`- if (LocalClientCannotWrite())`
	`496`	`+ if (CannotWrite())`
`497`	`497`	`{`
`498`	`498`	`LogWritePermissionError();`
`499`	`499`	`return false;`
`@@ -542,7 +542,7 @@ public int IndexOf(T item)`
`542`	`542`	`public void Insert(int index, T item)`
`543`	`543`	`{`
`544`	`544`	`// check write permissions`
`545`		`- if (LocalClientCannotWrite())`
	`545`	`+ if (CannotWrite())`
`546`	`546`	`{`
`547`	`547`	`LogWritePermissionError();`
`548`	`548`	`return;`
`@@ -578,7 +578,7 @@ public void Insert(int index, T item)`
`578`	`578`	`public void RemoveAt(int index)`
`579`	`579`	`{`
`580`	`580`	`// check write permissions`
`581`		`- if (LocalClientCannotWrite())`
	`581`	`+ if (CannotWrite())`
`582`	`582`	`{`
`583`	`583`	`throw new InvalidOperationException("Client is not allowed to write to this NetworkList");`
`584`	`584`	`}`
`@@ -610,7 +610,7 @@ public T this[int index]`
`610`	`610`	`set`
`611`	`611`	`{`
`612`	`612`	`// check write permissions`
`613`		`- if (LocalClientCannotWrite())`
	`613`	`+ if (CannotWrite())`
`614`	`614`	`{`
`615`	`615`	`LogWritePermissionError();`
`616`	`616`	`return;`
Original file line number	Diff line number	Diff line change
`@@ -128,7 +128,7 @@ public virtual T Value`
`128`	`128`	`get => m_InternalValue;`
`129`	`129`	`set`
`130`	`130`	`{`
`131`		`- if (LocalClientCannotWrite())`
	`131`	`+ if (CannotWrite())`
`132`	`132`	`{`
`133`	`133`	`LogWritePermissionError();`
`134`	`134`	`return;`
`@@ -162,7 +162,7 @@ public bool CheckDirtyState(bool forceCheck = false)`
`162`	`162`	`var isDirty = base.IsDirty();`
`163`	`163`
`164`	`164`	`// 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 (LocalClientCannotWrite())`
	`165`	`+ if (CannotWrite())`
`166`	`166`	`{`
`167`	`167`	`// If modifications are detected, then revert back to the last known current value`
`168`	`168`	`if (!NetworkVariableSerialization<T>.AreEqual(ref m_InternalValue, ref m_InternalOriginalValue))`
`@@ -245,7 +245,7 @@ public override bool IsDirty()`
`245`	`245`	`{`
`246`	`246`	`// 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`
`247`	`247`	`// to the original collection value prior to applying updates (primarily for collections).`
`248`		`- if (!NetworkUpdaterCheck && LocalClientCannotWrite() && !NetworkVariableSerialization<T>.AreEqual(ref m_InternalValue, ref m_InternalOriginalValue))`
	`248`	`+ if (!NetworkUpdaterCheck && CannotWrite() && !NetworkVariableSerialization<T>.AreEqual(ref m_InternalValue, ref m_InternalOriginalValue))`
`249`	`249`	`{`
`250`	`250`	`NetworkVariableSerialization<T>.Duplicate(m_InternalOriginalValue, ref m_InternalValue);`
`251`	`251`	`return true;`
`@@ -307,7 +307,7 @@ public override void ReadDelta(FastBufferReader reader, bool keepDirtyDelta)`
`307`	`307`	`{`
`308`	`308`	`// 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`
`309`	`309`	`// to the original collection value prior to applying updates (primarily for collections).`
`310`		`- if (LocalClientCannotWrite() && !NetworkVariableSerialization<T>.AreEqual(ref m_InternalOriginalValue, ref m_InternalValue))`
	`310`	`+ if (CannotWrite() && !NetworkVariableSerialization<T>.AreEqual(ref m_InternalOriginalValue, ref m_InternalValue))`
`311`	`311`	`{`
`312`	`312`	`NetworkVariableSerialization<T>.Duplicate(m_InternalOriginalValue, ref m_InternalValue);`
`313`	`313`	`}`
`@@ -349,7 +349,7 @@ public override void ReadField(FastBufferReader reader)`
`349`	`349`	`{`
`350`	`350`	`// 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`
`351`	`351`	`// to the original collection value prior to applying updates (primarily for collections).`
`352`		`- if (LocalClientCannotWrite() && !NetworkVariableSerialization<T>.AreEqual(ref m_InternalOriginalValue, ref m_InternalValue))`
	`352`	`+ if (CannotWrite() && !NetworkVariableSerialization<T>.AreEqual(ref m_InternalOriginalValue, ref m_InternalValue))`
`353`	`353`	`{`
`354`	`354`	`NetworkVariableSerialization<T>.Duplicate(m_InternalOriginalValue, ref m_InternalValue);`
`355`	`355`	`}`