Documented NetworkedInstanceId, PrefabHash and PrefabHashGenerator

Author: TwoTenPvP

MLAPI-Editor/NetworkedObjectEditor.cs

@@ -41,7 +41,7 @@ public override void OnInspectorGUI()
             {
                 EditorGUILayout.LabelField("PrefabName: ", networkedObject.PrefabHashGenerator, EditorStyles.label);
                 EditorGUILayout.LabelField("PrefabHash: ", networkedObject.PrefabHash.ToString(), EditorStyles.label);
-                EditorGUILayout.LabelField("InstanceId: ", networkedObject.PrefabInstanceId.ToString(), EditorStyles.label);
+                EditorGUILayout.LabelField("InstanceId: ", networkedObject.NetworkedInstanceId.ToString(), EditorStyles.label);
                 EditorGUILayout.LabelField("NetworkId: ", networkedObject.NetworkId.ToString(), EditorStyles.label);
                 EditorGUILayout.LabelField("OwnerId: ", networkedObject.OwnerClientId.ToString(), EditorStyles.label);
                 EditorGUILayout.LabelField("IsSpawned: ", networkedObject.IsSpawned.ToString(), EditorStyles.label);

MLAPI/MonoBehaviours/Core/NetworkedObject.cs

@@ -55,8 +55,26 @@ internal set
         }
         private uint? _ownerClientId = null;
 
-        public ulong PrefabInstanceId;
+        /// <summary>
+        /// InstanceId is the id that is unique to the object and scene for a scene object when UsePrefabSync is false.
+        /// If UsePrefabSync is true or if it's used on non scene objects, this has no effect.
+        /// Should not be set manually
+        /// </summary>
+        [HideInInspector]
+        [SerializeField]
+        public ulong NetworkedInstanceId;
+        /// <summary>
+        /// The Prefab unique hash. This should not be set my the user but rather changed by editing the PrefabHashGenerator.
+        /// It has to be the same for all instances of a prefab
+        /// </summary>
+        [HideInInspector]
+        [SerializeField]
         public ulong PrefabHash;
+        /// <summary>
+        /// The generator used to change the PrefabHash. This should be set the same for all instances of a prefab.
+        /// It has to be unique in relation to other prefabs
+        /// </summary>
+        [SerializeField]
         public string PrefabHashGenerator;
         [Obsolete("Use IsPlayerObject instead", false)]
         public bool isPlayerObject => IsPlayerObject;

MLAPI/MonoBehaviours/Core/NetworkingManager.cs

@@ -1094,7 +1094,7 @@ internal void HandleApproval(uint clientId, ulong? prefabHash, bool approved, Ve
 
                                 if (_observedObjects[i].IsSceneObject == null || _observedObjects[i].IsSceneObject.Value == true)
                                 {
-                                    writer.WriteUInt64Packed(_observedObjects[i].PrefabInstanceId);
+                                    writer.WriteUInt64Packed(_observedObjects[i].NetworkedInstanceId);
                                 }
                                 else
                                 {

MLAPI/NetworkingManagerComponents/Core/NetworkSceneManager.cs

@@ -232,7 +232,7 @@ private static void OnSceneUnloadServer(AsyncOperation operation, Guid switchSce
                                         writer.WriteUInt64Packed(newSceneObjects[i].NetworkId);
                                         writer.WriteUInt32Packed(newSceneObjects[i].OwnerClientId);
 
-                                        writer.WriteUInt64Packed(newSceneObjects[i].PrefabInstanceId);
+                                        writer.WriteUInt64Packed(newSceneObjects[i].NetworkedInstanceId);
 
                                         newSceneObjects[i].WriteNetworkedVarData(stream, NetworkingManager.Singleton.ConnectedClientsList[j].ClientId);
                                     }

MLAPI/NetworkingManagerComponents/Core/SpawnManager.cs

@@ -311,7 +311,7 @@ internal static void SendSpawnCallForObject(uint clientId, NetworkedObject netOb
 
                         if (netObject.IsSceneObject == null || netObject.IsSceneObject.Value)
                         {
-                            writer.WriteUInt64Packed(netObject.PrefabInstanceId);
+                            writer.WriteUInt64Packed(netObject.NetworkedInstanceId);
                         }
                         else
                         {
@@ -442,7 +442,7 @@ internal static void ClientCollectSoftSyncSceneObjectSweep(NetworkedObject[] net
             {
                 if (networkedObjects[i].IsSceneObject == null)
                 {
-                    pendingSoftSyncObjects.Add(networkedObjects[i].PrefabInstanceId, networkedObjects[i]);
+                    pendingSoftSyncObjects.Add(networkedObjects[i].NetworkedInstanceId, networkedObjects[i]);
                 }
             }
         }