refactor: changing indexer to try get (MirageNet#720)

* refactor: changing indexer to try get It would be better to return bool if not found to avoid doing null check BREAKING CHANGE: ObjectLocator now has TryGet method instead of indexer that returns null * updating uses of objectLocator * fixing names not being the same
James-Frowen · Mar 24, 2021 · 01ca9bb · 01ca9bb
1 parent ff95634
commit 01ca9bb
Show file tree

Hide file tree

Showing 7 changed files with 29 additions and 39 deletions.
diff --git a/Assets/Mirage/Runtime/ClientObjectManager.cs b/Assets/Mirage/Runtime/ClientObjectManager.cs
@@ -603,13 +603,9 @@ private void OnServerRpcReply(INetworkPlayer player, ServerRpcReply reply)
         private readonly Dictionary<int, Action<NetworkReader>> callbacks = new Dictionary<int, Action<NetworkReader>>();
         private int replyId;
 
-        public NetworkIdentity this[uint netId]
+        public bool TryGetIdentity(uint netId, out NetworkIdentity identity)
         {
-            get
-            {
-                SpawnedObjects.TryGetValue(netId, out NetworkIdentity identity);
-                return identity;
-            }
+            return SpawnedObjects.TryGetValue(netId, out identity) && identity != null;
         }
 
         /// <summary>

diff --git a/Assets/Mirage/Runtime/GameObjectSyncvar.cs b/Assets/Mirage/Runtime/GameObjectSyncvar.cs
@@ -1,4 +1,4 @@
-using Mirage.Serialization;
+using Mirage.Serialization;
 using UnityEngine;
 
 namespace Mirage
@@ -28,11 +28,9 @@ public GameObject Value
                 if (gameObject != null)
                     return gameObject;
 
-                if (objectLocator != null)
+                if (objectLocator != null && objectLocator.TryGetIdentity(NetId, out NetworkIdentity result))
                 {
-                    NetworkIdentity result = objectLocator[netId];
-                    if (result != null)
-                        return result.gameObject;
+                    return result.gameObject;
                 }
 
                 return null;
@@ -60,15 +58,14 @@ public static GameObjectSyncvar ReadGameObjectSyncVar(this NetworkReader reader)
             uint netId = reader.ReadPackedUInt32();
 
             NetworkIdentity identity = null;
-            if (!(reader.ObjectLocator is null))
-                identity = reader.ObjectLocator[netId];
+            bool hasValue = reader.ObjectLocator?.TryGetIdentity(netId, out identity) ?? false;
 
             return new GameObjectSyncvar
             {
                 objectLocator = reader.ObjectLocator,
                 netId = netId,
-                gameObject = identity != null ? identity.gameObject : null
+                gameObject = hasValue ? identity.gameObject : null
             };
         }
     }
-}
+}
diff --git a/Assets/Mirage/Runtime/IObjectLocator.cs b/Assets/Mirage/Runtime/IObjectLocator.cs
@@ -10,7 +10,8 @@ public interface IObjectLocator
         /// Finds a network identity by id
         /// </summary>
         /// <param name="netId">the id of the object to find</param>
-        /// <returns>The NetworkIdentity matching the netid or null if none is found</returns>
-        NetworkIdentity this[uint netId] { get; }
+        /// <param name="identity">The NetworkIdentity matching the netid or null if none is found</param>
+        /// <returns>true if identity is found and is not null</returns>
+        bool TryGetIdentity(uint netId, out NetworkIdentity identity);
     }
 }
diff --git a/Assets/Mirage/Runtime/NetworkBehaviorSyncvar.cs b/Assets/Mirage/Runtime/NetworkBehaviorSyncvar.cs
@@ -1,4 +1,4 @@
-using Mirage.Serialization;
+using Mirage.Serialization;
 
 namespace Mirage
 {
@@ -29,13 +29,12 @@ public NetworkBehaviour Value
                 if (component != null)
                     return component;
 
-                if (objectLocator != null)
+                if (objectLocator != null && objectLocator.TryGetIdentity(NetId, out NetworkIdentity result))
                 {
-                    NetworkIdentity identity = objectLocator[netId];
-                    if (identity != null)
-                        return identity.NetworkBehaviours[componentId];
+                    return result.NetworkBehaviours[componentId];
                 }
 
+
                 return null;
             }
 
@@ -66,16 +65,15 @@ public static NetworkBehaviorSyncvar ReadNetworkBehaviourSyncVar(this NetworkRea
             int componentId = reader.ReadPackedInt32();
 
             NetworkIdentity identity = null;
-            if (!(reader.ObjectLocator is null))
-                identity = reader.ObjectLocator[netId];
+            bool hasValue = reader.ObjectLocator?.TryGetIdentity(netId, out identity) ?? false;
 
             return new NetworkBehaviorSyncvar
             {
                 objectLocator = reader.ObjectLocator,
                 netId = netId,
                 componentId = componentId,
-                component = identity != null ? identity.NetworkBehaviours[componentId] : null
+                component = hasValue ? identity.NetworkBehaviours[componentId] : null
             };
         }
     }
-}
+}
diff --git a/Assets/Mirage/Runtime/NetworkIdentitySyncvar.cs b/Assets/Mirage/Runtime/NetworkIdentitySyncvar.cs
@@ -1,4 +1,4 @@
-using Mirage.Serialization;
+using Mirage.Serialization;
 
 namespace Mirage
 {
@@ -27,9 +27,9 @@ public NetworkIdentity Value
                 if (identity != null)
                     return identity;
 
-                if (objectLocator != null)
+                if (objectLocator != null && objectLocator.TryGetIdentity(NetId, out NetworkIdentity result))
                 {
-                    return objectLocator[netId];
+                    return result;
                 }
 
                 return null;
@@ -57,8 +57,7 @@ public static NetworkIdentitySyncvar ReadNetworkIdentitySyncVar(this NetworkRead
             uint netId = reader.ReadPackedUInt32();
 
             NetworkIdentity identity = null;
-            if (!(reader.ObjectLocator is null))
-                identity = reader.ObjectLocator[netId];
+            reader.ObjectLocator?.TryGetIdentity(netId, out identity);
 
             return new NetworkIdentitySyncvar
             {
@@ -68,4 +67,4 @@ public static NetworkIdentitySyncvar ReadNetworkIdentitySyncVar(this NetworkRead
             };
         }
     }
-}
+}
diff --git a/Assets/Mirage/Runtime/Serialization/NetworkReader.cs b/Assets/Mirage/Runtime/Serialization/NetworkReader.cs
@@ -391,7 +391,10 @@ public static NetworkIdentity ReadNetworkIdentity(this NetworkReader reader)
 
             if (reader.ObjectLocator != null)
             {
-                return reader.ObjectLocator[netId];
+                // if not found return c# null
+                return reader.ObjectLocator.TryGetIdentity(netId, out NetworkIdentity identity)
+                    ? identity
+                    : null;
             }
 
             if (logger.WarnEnabled()) logger.LogFormat(LogType.Warning, "ReadNetworkIdentity netId:{0} not found in spawned", netId);

diff --git a/Assets/Mirage/Runtime/ServerObjectManager.cs b/Assets/Mirage/Runtime/ServerObjectManager.cs
@@ -69,13 +69,9 @@ public class ServerObjectManager : MonoBehaviour, IServerObjectManager, IObjectL
         public readonly HashSet<NetworkIdentity> DirtyObjects = new HashSet<NetworkIdentity>();
         private readonly List<NetworkIdentity> DirtyObjectsTmp = new List<NetworkIdentity>();
 
-        public NetworkIdentity this[uint netId]
+        public bool TryGetIdentity(uint netId, out NetworkIdentity identity)
         {
-            get
-            {
-                SpawnedObjects.TryGetValue(netId, out NetworkIdentity identity);
-                return identity;
-            }
+            return SpawnedObjects.TryGetValue(netId, out identity) && identity != null;
         }
 
         public void Start()