Use SceneHandle in place of int

Author: EmandM

com.unity.netcode.gameobjects/Runtime/Core/NetworkObject.cs

@@ -1367,12 +1367,12 @@ public bool IsNetworkVisibleTo(ulong clientId)
         ///  the most important part to uniquely identify in-scene
         ///  placed NetworkObjects
         /// </summary>
-        internal int SceneOriginHandle = 0;
+        internal SceneHandle SceneOriginHandle;
 
         /// <summary>
         /// The server-side scene origin handle
         /// </summary>
-        internal int NetworkSceneHandle = 0;
+        internal SceneHandle NetworkSceneHandle;
 
         private Scene m_SceneOrigin;
         /// <summary>
@@ -1393,7 +1393,7 @@ internal Scene SceneOrigin
             {
                 // The scene origin should only be set once.
                 // Once set, it should never change.
-                if (SceneOriginHandle == 0 && value.IsValid() && value.isLoaded)
+                if (SceneOriginHandle == SceneHandle.None && value.IsValid() && value.isLoaded)
                 {
                     m_SceneOrigin = value;
                     SceneOriginHandle = value.handle;
@@ -1405,13 +1405,13 @@ internal Scene SceneOrigin
         /// Helper method to return the correct scene handle
         /// Note: Do not use this within NetworkSpawnManager.SpawnNetworkObjectLocallyCommon
         /// </summary>
-        internal int GetSceneOriginHandle()
+        internal SceneHandle GetSceneOriginHandle()
         {
-            if (SceneOriginHandle == 0 && IsSpawned && IsSceneObject != false)
+            if (SceneOriginHandle == SceneHandle.None && IsSpawned && IsSceneObject != false)
             {
                 throw new Exception($"{nameof(GetSceneOriginHandle)} called when {nameof(SceneOriginHandle)} is still zero but the {nameof(NetworkObject)} is already spawned!");
             }
-            return SceneOriginHandle != 0 ? SceneOriginHandle : gameObject.scene.handle;
+            return SceneOriginHandle != SceneHandle.None ? SceneOriginHandle : gameObject.scene.handle;
         }
 
         /// <summary>
@@ -2907,7 +2907,7 @@ public struct TransformData : INetworkSerializeByMemcpy
             public NetworkObject OwnerObject;
             public ulong TargetClientId;
 
-            public int NetworkSceneHandle;
+            public SceneHandle NetworkSceneHandle;
 
             internal int SynchronizationDataSize;
 

com.unity.netcode.gameobjects/Runtime/SceneManagement/DefaultSceneManagerHandler.cs

@@ -20,7 +20,7 @@ internal struct SceneEntry
         }
         public bool IsIntegrationTest() { return false; }
 
-        internal Dictionary<string, Dictionary<int, SceneEntry>> SceneNameToSceneHandles = new Dictionary<string, Dictionary<int, SceneEntry>>();
+        internal Dictionary<string, Dictionary<SceneHandle, SceneEntry>> SceneNameToSceneHandles = new();
 
         public AsyncOperation LoadSceneAsync(string sceneName, LoadSceneMode loadSceneMode, SceneEventProgress sceneEventProgress)
         {
@@ -47,7 +47,7 @@ public void ClearSceneTracking(NetworkManager networkManager)
         /// <summary>
         /// Stops tracking a specific scene
         /// </summary>
-        public void StopTrackingScene(int handle, string name, NetworkManager networkManager)
+        public void StopTrackingScene(SceneHandle handle, string name, NetworkManager networkManager)
         {
             if (SceneNameToSceneHandles.ContainsKey(name))
             {
@@ -69,7 +69,7 @@ public void StartTrackingScene(Scene scene, bool assigned, NetworkManager networ
         {
             if (!SceneNameToSceneHandles.ContainsKey(scene.name))
             {
-                SceneNameToSceneHandles.Add(scene.name, new Dictionary<int, SceneEntry>());
+                SceneNameToSceneHandles.Add(scene.name, new Dictionary<SceneHandle, SceneEntry>());
             }
 
             if (!SceneNameToSceneHandles[scene.name].ContainsKey(scene.handle))
@@ -168,7 +168,7 @@ public Scene GetSceneFromLoadedScenes(string sceneName, NetworkManager networkMa
         /// same application instance is still running, the same scenes are still loaded on the client, and
         /// upon reconnecting the client doesn't have to unload the scenes and then reload them)
         /// </summary>
-        public void PopulateLoadedScenes(ref Dictionary<int, Scene> scenesLoaded, NetworkManager networkManager)
+        public void PopulateLoadedScenes(ref Dictionary<SceneHandle, Scene> scenesLoaded, NetworkManager networkManager)
         {
             SceneNameToSceneHandles.Clear();
             var sceneCount = SceneManager.sceneCount;
@@ -177,7 +177,7 @@ public void PopulateLoadedScenes(ref Dictionary<int, Scene> scenesLoaded, Networ
                 var scene = SceneManager.GetSceneAt(i);
                 if (!SceneNameToSceneHandles.ContainsKey(scene.name))
                 {
-                    SceneNameToSceneHandles.Add(scene.name, new Dictionary<int, SceneEntry>());
+                    SceneNameToSceneHandles.Add(scene.name, new Dictionary<SceneHandle, SceneEntry>());
                 }
 
                 if (!SceneNameToSceneHandles[scene.name].ContainsKey(scene.handle))

com.unity.netcode.gameobjects/Runtime/SceneManagement/ISceneManagerHandler.cs

@@ -14,12 +14,12 @@ internal interface ISceneManagerHandler
 
         AsyncOperation UnloadSceneAsync(Scene scene, SceneEventProgress sceneEventProgress);
 
-        void PopulateLoadedScenes(ref Dictionary<int, Scene> scenesLoaded, NetworkManager networkManager = null);
+        void PopulateLoadedScenes(ref Dictionary<SceneHandle, Scene> scenesLoaded, NetworkManager networkManager = null);
         Scene GetSceneFromLoadedScenes(string sceneName, NetworkManager networkManager = null);
 
         bool DoesSceneHaveUnassignedEntry(string sceneName, NetworkManager networkManager = null);
 
-        void StopTrackingScene(int handle, string name, NetworkManager networkManager = null);
+        void StopTrackingScene(SceneHandle handle, string name, NetworkManager networkManager = null);
 
         void StartTrackingScene(Scene scene, bool assigned, NetworkManager networkManager = null);
 

com.unity.netcode.gameobjects/Runtime/SceneManagement/NetworkSceneManager.cs

@@ -420,7 +420,7 @@ public bool ActiveSceneSynchronizationEnabled
         /// The Scene.Handle aspect allows us to distinguish duplicated in-scene placed NetworkObjects created by the loading
         /// of the same additive scene multiple times.
         /// </summary>
-        internal readonly Dictionary<uint, Dictionary<int, NetworkObject>> ScenePlacedObjects = new Dictionary<uint, Dictionary<int, NetworkObject>>();
+        internal readonly Dictionary<uint, Dictionary<SceneHandle, NetworkObject>> ScenePlacedObjects = new();
 
         /// <summary>
         /// This is used for the deserialization of in-scene placed NetworkObjects in order to distinguish duplicated in-scene
@@ -436,7 +436,7 @@ public bool ActiveSceneSynchronizationEnabled
         /// The client links the server scene handle to the client local scene handle upon a scene being loaded
         /// <see cref="GetAndAddNewlyLoadedSceneByName"/>
         /// </summary>
-        internal Dictionary<int, Scene> ScenesLoaded = new Dictionary<int, Scene>();
+        internal Dictionary<SceneHandle, Scene> ScenesLoaded = new();
 
         /// <summary>
         /// Returns the currently loaded scenes that are synchronized with the session owner or server depending upon the selected
@@ -456,16 +456,16 @@ public List<Scene> GetSynchronizedScenes()
         /// Since Scene.handle is unique per client, we create a look-up table between the client and server to associate server unique scene
         /// instances with client unique scene instances
         /// </summary>
-        internal Dictionary<int, int> ServerSceneHandleToClientSceneHandle = new Dictionary<int, int>();
-        internal Dictionary<int, int> ClientSceneHandleToServerSceneHandle = new Dictionary<int, int>();
+        internal Dictionary<SceneHandle, SceneHandle> ServerSceneHandleToClientSceneHandle = new();
+        internal Dictionary<SceneHandle, SceneHandle> ClientSceneHandleToServerSceneHandle = new();
 
         internal bool IsRestoringSession;
         /// <summary>
         /// Add the client to server (and vice versa) scene handle lookup.
         /// Add the client-side handle to scene entry in the HandleToScene table.
         /// If it fails (i.e. already added) it returns false.
         /// </summary>
-        internal bool UpdateServerClientSceneHandle(int serverHandle, int clientHandle, Scene localScene)
+        internal bool UpdateServerClientSceneHandle(SceneHandle serverHandle, SceneHandle clientHandle, Scene localScene)
         {
             if (!ServerSceneHandleToClientSceneHandle.ContainsKey(serverHandle))
             {
@@ -498,7 +498,7 @@ internal bool UpdateServerClientSceneHandle(int serverHandle, int clientHandle,
         /// Removes the client to server (and vice versa) scene handles.
         /// If it fails (i.e. already removed) it returns false.
         /// </summary>
-        internal bool RemoveServerClientSceneHandle(int serverHandle, int clientHandle)
+        internal bool RemoveServerClientSceneHandle(SceneHandle serverHandle, SceneHandle clientHandle)
         {
             if (ServerSceneHandleToClientSceneHandle.ContainsKey(serverHandle))
             {
@@ -989,7 +989,7 @@ internal Scene GetAndAddNewlyLoadedSceneByName(string sceneName)
         /// value.  Scene handles are used to distinguish between in-scene placed NetworkObjects under this situation.
         /// </summary>
         /// <param name="serverSceneHandle"></param>
-        internal void SetTheSceneBeingSynchronized(int serverSceneHandle)
+        internal void SetTheSceneBeingSynchronized(SceneHandle serverSceneHandle)
         {
             var clientSceneHandle = serverSceneHandle;
             if (ServerSceneHandleToClientSceneHandle.ContainsKey(serverSceneHandle))
@@ -1037,20 +1037,19 @@ internal void SetTheSceneBeingSynchronized(int serverSceneHandle)
         /// <summary>
         /// During soft synchronization of in-scene placed NetworkObjects, this is now used by NetworkSpawnManager.CreateLocalNetworkObject
         /// </summary>
-        /// <param name="globalObjectIdHash"></param>
-        /// <returns></returns>
-        internal NetworkObject GetSceneRelativeInSceneNetworkObject(uint globalObjectIdHash, int? networkSceneHandle)
+        internal NetworkObject GetSceneRelativeInSceneNetworkObject(uint globalObjectIdHash, SceneHandle? networkSceneHandle)
         {
             if (ScenePlacedObjects.ContainsKey(globalObjectIdHash))
             {
-                var sceneHandle = SceneBeingSynchronized.handle;
-                if (networkSceneHandle.HasValue && networkSceneHandle.Value != 0 && ServerSceneHandleToClientSceneHandle.ContainsKey(networkSceneHandle.Value))
+                SceneHandle sceneHandle = SceneBeingSynchronized.handle;
+                if (networkSceneHandle.HasValue && networkSceneHandle.Value != SceneHandle.None &&
+                    ServerSceneHandleToClientSceneHandle.TryGetValue(networkSceneHandle.Value, out var clientHandle))
                 {
-                    sceneHandle = ServerSceneHandleToClientSceneHandle[networkSceneHandle.Value];
+                    sceneHandle = clientHandle;
                 }
-                if (ScenePlacedObjects[globalObjectIdHash].ContainsKey(sceneHandle))
+                if (ScenePlacedObjects[globalObjectIdHash].TryGetValue(sceneHandle, out var scenePlaceObject))
                 {
-                    return ScenePlacedObjects[globalObjectIdHash][sceneHandle];
+                    return scenePlaceObject;
                 }
             }
             return null;
@@ -1252,7 +1251,7 @@ private bool OnSceneEventProgressCompleted(SceneEventProgress sceneEventProgress
         public SceneEventProgressStatus UnloadScene(Scene scene)
         {
             var sceneName = scene.name;
-            var sceneHandle = scene.handle;
+            SceneHandle sceneHandle = scene.handle;
 
             if (!scene.isLoaded)
             {
@@ -2751,7 +2750,7 @@ internal void PopulateScenePlacedObjects(Scene sceneToFilterBy, bool clearSceneP
                 {
                     if (!ScenePlacedObjects.ContainsKey(globalObjectIdHash))
                     {
-                        ScenePlacedObjects.Add(globalObjectIdHash, new Dictionary<int, NetworkObject>());
+                        ScenePlacedObjects.Add(globalObjectIdHash, new Dictionary<SceneHandle, NetworkObject>());
                     }
 
                     if (!ScenePlacedObjects[globalObjectIdHash].ContainsKey(sceneHandle))
@@ -2797,7 +2796,10 @@ internal void MoveObjectsFromDontDestroyOnLoadToScene(Scene scene)
                             }
                             else
                             {
-                                networkObject.NetworkSceneHandle = ClientSceneHandleToServerSceneHandle[scene.handle];
+                                if (ClientSceneHandleToServerSceneHandle.TryGetValue(scene.handle, out var handle))
+                                {
+                                    networkObject.NetworkSceneHandle = handle;
+                                }
                             }
                             networkObject.SceneOriginHandle = scene.handle;
                         }
@@ -2812,7 +2814,7 @@ internal void MoveObjectsFromDontDestroyOnLoadToScene(Scene scene)
         /// Holds a list of scene handles (server-side relative) and NetworkObjects migrated into it
         /// during the current frame.
         /// </summary>
-        internal Dictionary<int, Dictionary<ulong, List<NetworkObject>>> ObjectsMigratedIntoNewScene = new Dictionary<int, Dictionary<ulong, List<NetworkObject>>>();
+        internal Dictionary<SceneHandle, Dictionary<ulong, List<NetworkObject>>> ObjectsMigratedIntoNewScene = new();
 
         internal bool IsSceneEventInProgress()
         {
@@ -2917,18 +2919,16 @@ internal void MigrateNetworkObjectsIntoScenes()
             {
                 foreach (var sceneEntry in ObjectsMigratedIntoNewScene)
                 {
-                    if (ServerSceneHandleToClientSceneHandle.ContainsKey(sceneEntry.Key))
+                    if (ServerSceneHandleToClientSceneHandle.TryGetValue(sceneEntry.Key, out var clientSceneHandle))
                     {
-                        var clientSceneHandle = ServerSceneHandleToClientSceneHandle[sceneEntry.Key];
                         foreach (var ownerEntry in sceneEntry.Value)
                         {
                             if (ownerEntry.Key == NetworkManager.LocalClientId)
                             {
                                 continue;
                             }
-                            if (ScenesLoaded.ContainsKey(clientSceneHandle))
+                            if (ScenesLoaded.TryGetValue(clientSceneHandle, out var scene))
                             {
-                                var scene = ScenesLoaded[clientSceneHandle];
                                 foreach (var networkObject in ownerEntry.Value)
                                 {
                                     SceneManager.MoveGameObjectToScene(networkObject.gameObject, scene);
@@ -2947,7 +2947,7 @@ internal void MigrateNetworkObjectsIntoScenes()
         }
 
 
-        private List<int> m_ScenesToRemoveFromObjectMigration = new List<int>();
+        private List<SceneHandle> m_ScenesToRemoveFromObjectMigration = new();
 
         /// <summary>
         /// Should be invoked during PostLateUpdate just prior to the NetworkMessageManager processes its outbound message queue.
@@ -3025,7 +3025,7 @@ internal void CheckForAndSendNetworkObjectSceneChanged()
         internal struct DeferredObjectsMovedEvent
         {
             internal ulong OwnerId;
-            internal Dictionary<int, List<ulong>> ObjectsMigratedTable;
+            internal Dictionary<SceneHandle, List<ulong>> ObjectsMigratedTable;
         }
         internal List<DeferredObjectsMovedEvent> DeferredObjectsMovedEvents = new List<DeferredObjectsMovedEvent>();
 
@@ -3167,9 +3167,15 @@ public List<SceneMap> GetSceneMapping(MapTypes mapType)
                     var sceneMap = new SceneMap()
                     {
                         MapType = mapType,
+#if SCENE_MANAGEMENT_SCENE_HANDLE_NO_INT_CONVERSION
+                        ServerHandle = entry.Key.GetRawData(),
+                        MappedLocalHandle = entry.Value.GetRawData(),
+                        LocalHandle = scene.handle.GetRawData(),
+#else
                         ServerHandle = entry.Key,
                         MappedLocalHandle = entry.Value,
                         LocalHandle = scene.handle,
+#endif
                         Scene = scene,
                         ScenePresent = sceneIsPresent,
                         SceneName = sceneIsPresent ? scene.name : "NotPresent",
@@ -3186,9 +3192,15 @@ public List<SceneMap> GetSceneMapping(MapTypes mapType)
                     var sceneMap = new SceneMap()
                     {
                         MapType = mapType,
-                        ServerHandle = entry.Value,
-                        MappedLocalHandle = entry.Key,
+#if SCENE_MANAGEMENT_SCENE_HANDLE_NO_INT_CONVERSION
+                        ServerHandle = entry.Key,
+                        MappedLocalHandle = entry.Value,
+                        LocalHandle = scene.handle,
+#else
+                        ServerHandle = entry.Key,
+                        MappedLocalHandle = entry.Value,
                         LocalHandle = scene.handle,
+#endif
                         Scene = scene,
                         ScenePresent = sceneIsPresent,
                         SceneName = sceneIsPresent ? scene.name : "NotPresent",