feat(config): Added option to disable NetworkedVar

Author: TwoTenPvP

MLAPI/Data/NetworkConfig.cs

@@ -84,6 +84,11 @@ public class NetworkConfig
         /// </summary>
         public bool EnableTimeResync = false;
         /// <summary>
+        /// Whether or not to enable the NetworkedVar system. This system runs in the Update loop and will degrade performance, but it can be a huge convenience.
+        /// Only turn it off if you have no need for the NetworkedVar system.
+        /// </summary>
+        public bool EnableNetworkedVar = true;
+        /// <summary>
         /// Wheter or not the MLAPI should check for differences in the prefabs at connection. 
         /// If you dynamically add prefabs at runtime, turn this OFF
         /// </summary>
@@ -184,6 +189,7 @@ public string ToBase64()
                     writer.WriteBits((byte)config.RpcHashSize, 3);
                     writer.WriteBool(ForceSamePrefabs);
                     writer.WriteBool(UsePrefabSync);
+                    writer.WriteBool(EnableNetworkedVar);
                     stream.PadStream();
 
                     return Convert.ToBase64String(stream.ToArray());
@@ -227,6 +233,7 @@ public void FromBase64(string base64)
                     config.RpcHashSize = (HashSize)reader.ReadBits(3);
                     config.ForceSamePrefabs = reader.ReadBool();
                     config.UsePrefabSync = reader.ReadBool();
+                    config.EnableNetworkedVar = reader.ReadBool();
                 }
             }
         }
@@ -266,6 +273,7 @@ public ulong GetConfig(bool cache = true)
                         }
                     }
 
+                    writer.WriteBool(EnableNetworkedVar);
                     writer.WriteBool(ForceSamePrefabs);
                     writer.WriteBool(UsePrefabSync);
                     writer.WriteBool(EnableEncryption);

MLAPI/MonoBehaviours/Core/NetworkingManager.cs

@@ -556,7 +556,10 @@ private void Update()
             {
                 if ((NetworkTime - lastSendTickTime >= (1f / NetworkConfig.SendTickrate)) || NetworkConfig.SendTickrate <= 0)
                 {
-                    NetworkedObject.NetworkedBehaviourUpdate();
+                    if (NetworkConfig.EnableNetworkedVar)
+                    {
+                        NetworkedObject.NetworkedBehaviourUpdate();
+                    }
 
                     foreach (KeyValuePair<ulong, NetworkedClient> pair in ConnectedClients)
                     {
@@ -1052,7 +1055,10 @@ internal void HandleApproval(ulong clientId, ulong? prefabHash, bool approved, V
                             writer.WriteSinglePacked(_observedObjects[i].transform.rotation.eulerAngles.y);
                             writer.WriteSinglePacked(_observedObjects[i].transform.rotation.eulerAngles.z);
 
-                            _observedObjects[i].WriteNetworkedVarData(stream, clientId);
+                            if (NetworkConfig.EnableNetworkedVar)
+                            {
+                                _observedObjects[i].WriteNetworkedVarData(stream, clientId);
+                            }
                         }
 
                         InternalMessageHandler.Send(clientId, MLAPIConstants.MLAPI_CONNECTION_APPROVED, "MLAPI_INTERNAL", stream, SecuritySendFlags.Encrypted | SecuritySendFlags.Authenticated, null, true);
@@ -1100,7 +1106,10 @@ internal void HandleApproval(ulong clientId, ulong? prefabHash, bool approved, V
 
                             writer.WriteBool(false); //No payload data
 
-                            ConnectedClients[clientId].PlayerObject.GetComponent<NetworkedObject>().WriteNetworkedVarData(stream, clientPair.Key);
+                            if (NetworkConfig.EnableNetworkedVar)
+                            {
+                                ConnectedClients[clientId].PlayerObject.WriteNetworkedVarData(stream, clientPair.Key);
+                            }
 
                             InternalMessageHandler.Send(clientPair.Key, MLAPIConstants.MLAPI_ADD_OBJECT, "MLAPI_INTERNAL", stream, SecuritySendFlags.None, null);
                         }

MLAPI/NetworkingManagerComponents/Core/InternalMessageHandler.Receive.cs

@@ -473,6 +473,12 @@ internal static void HandleTimeSync(ulong clientId, Stream stream)
 
         internal static void HandleNetworkedVarDelta(ulong clientId, Stream stream)
         {
+            if (!NetworkingManager.Singleton.NetworkConfig.EnableNetworkedVar)
+            {
+                if (LogHelper.CurrentLogLevel <= LogLevel.Normal) LogHelper.LogWarning("NetworkedVar delta received but EnableNetworkedVar is false");
+                return;
+            }
+            
             using (PooledBitReader reader = PooledBitReader.Get(stream))
             {
                 ulong networkId = reader.ReadUInt64Packed();
@@ -498,6 +504,12 @@ internal static void HandleNetworkedVarDelta(ulong clientId, Stream stream)
 
         internal static void HandleNetworkedVarUpdate(ulong clientId, Stream stream)
         {
+            if (!NetworkingManager.Singleton.NetworkConfig.EnableNetworkedVar)
+            {
+                if (LogHelper.CurrentLogLevel <= LogLevel.Normal) LogHelper.LogWarning("NetworkedVar update received but EnableNetworkedVar is false");
+                return;
+            }
+            
             using (PooledBitReader reader = PooledBitReader.Get(stream))
             {
                 ulong networkId = reader.ReadUInt64Packed();

MLAPI/NetworkingManagerComponents/Core/NetworkSceneManager.cs

@@ -228,7 +228,10 @@ private static void OnSceneUnloadServer(AsyncOperation operation, Guid switchSce
                                         writer.WriteSinglePacked(newSceneObjects[i].transform.rotation.eulerAngles.y);
                                         writer.WriteSinglePacked(newSceneObjects[i].transform.rotation.eulerAngles.z);
 
-                                        newSceneObjects[i].WriteNetworkedVarData(stream, NetworkingManager.Singleton.ConnectedClientsList[j].ClientId);
+                                        if (NetworkingManager.Singleton.NetworkConfig.EnableNetworkedVar)
+                                        {
+                                            newSceneObjects[i].WriteNetworkedVarData(stream, NetworkingManager.Singleton.ConnectedClientsList[j].ClientId);
+                                        }
                                     }
                                     else
                                     {
@@ -240,7 +243,10 @@ private static void OnSceneUnloadServer(AsyncOperation operation, Guid switchSce
 
                                         writer.WriteBool(newSceneObjects[i].DestroyWithScene);
 
-                                        newSceneObjects[i].WriteNetworkedVarData(stream, NetworkingManager.Singleton.ConnectedClientsList[j].ClientId);
+                                        if (NetworkingManager.Singleton.NetworkConfig.EnableNetworkedVar)
+                                        {
+                                            newSceneObjects[i].WriteNetworkedVarData(stream, NetworkingManager.Singleton.ConnectedClientsList[j].ClientId);
+                                        }
                                     }
                                 }
                             }

MLAPI/NetworkingManagerComponents/Core/SpawnManager.cs

@@ -270,7 +270,7 @@ internal static void SpawnNetworkedObjectLocally(NetworkedObject netObject, ulon
             }
 
 
-            if (readNetworkedVar) netObject.SetNetworkedVarData(dataStream);
+            if (readNetworkedVar && NetworkingManager.Singleton.NetworkConfig.EnableNetworkedVar) netObject.SetNetworkedVarData(dataStream);
 
             netObject.IsSpawned = true;
 
@@ -359,7 +359,10 @@ internal static void SendSpawnCallForObject(ulong clientId, NetworkedObject netO
                         writer.WriteInt32Packed((int)payload.Length);
                     }
 
-                    netObject.WriteNetworkedVarData(stream, clientId);
+                    if (NetworkingManager.Singleton.NetworkConfig.EnableNetworkedVar)
+                    {
+                        netObject.WriteNetworkedVarData(stream, clientId);
+                    }
 
                     if (payload != null) stream.CopyFrom(payload);
                 }