Merge branch 'experimental/v3-x-x/hybrid_spawn_integration_tests' into local/merging-kitty-tests-poc-merge

Author: NoelStephensUnity

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

@@ -1354,13 +1354,19 @@ private bool CanStart(StartType type)
         /// The world instance assigned to this NetworkManager instance.
         /// </summary>
         public NetcodeWorld NetcodeWorld { get; internal set; }
-        private System.Collections.IEnumerator WaitForHybridPrefabRegistration(StartType startType)
+        
+        internal void InitializeNetcodeWorld()
         {
+            if (NetcodeWorld != null)
+            {
+                return;
+            }
+            
             if (this == Singleton)
             {
                 if (NetCode.Netcode.IsActive)
                 {
-                    NetworkLog.LogInfo($"[{nameof(WaitForHybridPrefabRegistration)}] Netcode is not active but has an instance at this point.");
+                    NetworkLog.LogInfo($"[{nameof(InitializeNetcodeWorld)}] Netcode is not active but has an instance at this point.");
                 }
                 /// !! Important !!
                 /// Clear out any pre-existing configuration in the event this applicatioin instance has already been connected to a session.
@@ -1371,42 +1377,6 @@ private System.Collections.IEnumerator WaitForHybridPrefabRegistration(StartType
             /// Worlds are created here: <see cref="UnifiedBootStrap.Initialize"/>
             UnifiedBootstrap.CurrentNetworkManagerForInitialization = this;
             DefaultWorldInitialization.Initialize("Default World", false);
-
-            // This should not be needed at this point, but this is here in the event something changes.
-            if (NetworkConfig.Prefabs.HasPendingGhostPrefabs)
-            {
-                NetworkLog.LogWarning($"[{nameof(WaitForHybridPrefabRegistration)}] !!!!! (Ghosts are still pending registration) !!!!!");
-                var waitTime = new WaitForSeconds(0.016f);
-                while (NetworkConfig.Prefabs.HasPendingGhostPrefabs)
-                {
-                    NetworkConfig.Prefabs.RegisterGhostPrefabs(this);
-                    yield return waitTime;
-                }
-            }
-
-            if (LogLevel <= LogLevel.Developer)
-            {
-                NetworkLog.LogInfo($"[{nameof(WaitForHybridPrefabRegistration)}] All hybrid prefabs have been registered!");
-                NetworkLog.LogInfo($"[{nameof(WaitForHybridPrefabRegistration)}] Finalizing NetworkManager start...");
-            }
-            switch (startType)
-            {
-                case StartType.Server:
-                    {
-                        InternalStartServer();
-                        break;
-                    }
-                case StartType.Host:
-                    {
-                        InternalStartHost();
-                        break;
-                    }
-                case StartType.Client:
-                    {
-                        InternalStartClient();
-                        break;
-                    }
-            }
         }
 
         private bool UnifiedIsConfiguredCorrectly()
@@ -1470,8 +1440,8 @@ public bool StartServer()
                 {
                     Debug.Log("Creating world: Default world");
                 }
-                StartCoroutine(WaitForHybridPrefabRegistration(StartType.Server));
-                return true;
+                InitializeNetcodeWorld();
+                return InternalStartServer();
             }
             else
             {
@@ -1555,9 +1525,8 @@ public bool StartClient()
                 {
                     Debug.Log("Creating world: Default world");
                 }
-                StartCoroutine(WaitForHybridPrefabRegistration(StartType.Client));
-                // TODO-UNIFIED: Need a way to signal everything completed.
-                return true;
+                InitializeNetcodeWorld();
+                return InternalStartClient();
             }
             else
             {
@@ -1640,9 +1609,8 @@ public bool StartHost()
                 {
                     Debug.Log("Creating world: Default world");
                 }
-                StartCoroutine(WaitForHybridPrefabRegistration(StartType.Host));
-                // TODO-UNIFIED: Need a way to signal everything completed.
-                return true;
+                InitializeNetcodeWorld();
+                return InternalStartHost();
             }
             else
             {

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

@@ -2072,6 +2072,12 @@ public void SpawnAsPlayerObject(ulong clientId, bool destroyWithScene = false)
         /// <param name="destroy">(true) the <see cref="GameObject"/> will be destroyed (false) the <see cref="GameObject"/> will persist after being despawned</param>
         public void Despawn(bool destroy = true)
         {
+#if UNIFIED_NETCODE
+            if (HasGhost && destroy == false)
+            {
+                throw new NotSupportedException("Despawn without destroy is not supported for hybrid objects.");
+            }
+#endif
             if (!IsSpawned)
             {
                 if (NetworkManager.LogLevel <= LogLevel.Error)

com.unity.netcode.gameobjects/Runtime/Messaging/DeferredMessageManager.cs

@@ -125,6 +125,16 @@ protected virtual void PurgeTrigger(IDeferredNetworkMessageManager.TriggerType t
             triggerInfo.TriggerData.Dispose();
         }
 
+        public bool HasAnyOfTrigger(IDeferredNetworkMessageManager.TriggerType trigger)
+        {
+            if (m_Triggers.TryGetValue(trigger, out var triggers))
+            {
+                return triggers.Count != 0;
+            }
+
+            return false;
+        }
+
         public virtual void ProcessTriggers(IDeferredNetworkMessageManager.TriggerType trigger, ulong key)
         {
             if (m_Triggers.TryGetValue(trigger, out var triggers))
@@ -143,6 +153,11 @@ public virtual void ProcessTriggers(IDeferredNetworkMessageManager.TriggerType t
                     triggerInfo.TriggerData.Dispose();
                 }
             }
+
+            if (trigger != IDeferredNetworkMessageManager.TriggerType.OnOtherTriggerFinishedProcessing)
+            {
+                ProcessTriggers(IDeferredNetworkMessageManager.TriggerType.OnOtherTriggerFinishedProcessing, (ulong)trigger);
+            }
         }
 
         /// <summary>

com.unity.netcode.gameobjects/Runtime/Messaging/IDeferredNetworkMessageManager.cs

@@ -11,6 +11,7 @@ internal enum TriggerType
 #if UNIFIED_NETCODE
             OnGhostSpawned,
 #endif
+            OnOtherTriggerFinishedProcessing,
         }
 
         /// <summary>
@@ -31,6 +32,8 @@ internal enum TriggerType
 
         public void ProcessTriggers(TriggerType trigger, ulong key);
 
+        public bool HasAnyOfTrigger(IDeferredNetworkMessageManager.TriggerType trigger);
+
         /// <summary>
         /// Cleans up any trigger that's existed for more than a second.
         /// These triggers were probably for situations where a request was received after a despawn rather than before a spawn.

com.unity.netcode.gameobjects/Runtime/Messaging/Messages/SceneEventMessage.cs

@@ -8,6 +8,7 @@ internal struct SceneEventMessage : INetworkMessage
 
         public SceneEventData EventData;
 
+        private const string k_Name = "SceneEventMessage";
 
         private FastBufferReader m_ReceivedData;
 
@@ -18,6 +19,15 @@ public void Serialize(FastBufferWriter writer, int targetVersion)
 
         public bool Deserialize(FastBufferReader reader, ref NetworkContext context, int receivedMessageVersion)
         {
+            var networkManager = (NetworkManager)context.SystemOwner;
+#if UNIFIED_NETCODE
+            if (networkManager.DeferredMessageManager.HasAnyOfTrigger(IDeferredNetworkMessageManager.TriggerType
+                    .OnGhostSpawned))
+            {
+                networkManager.DeferredMessageManager.DeferMessage(IDeferredNetworkMessageManager.TriggerType.OnOtherTriggerFinishedProcessing, (ulong)IDeferredNetworkMessageManager.TriggerType.OnGhostSpawned, reader, ref context, k_Name);
+                return false;
+            }
+#endif
             m_ReceivedData = reader;
             return true;
         }

com.unity.netcode.gameobjects/Runtime/Messaging/NetworkMessageManager.cs

@@ -228,8 +228,6 @@ internal void HandleIncomingData(ulong clientId, ArraySegment<byte> data, float
         {
             unsafe
             {
-
-                //Debug.Log($"Receiving {data.Count} bytes: {ByteArrayToString(data.Array, data.Offset, data.Count)}");
                 fixed (byte* dataPtr = data.Array)
                 {
                     var batchReader = new FastBufferReader(dataPtr + data.Offset, Allocator.None, data.Count);
@@ -872,7 +870,6 @@ internal unsafe void ProcessSendQueues()
 
                     try
                     {
-                        //Debug.Log($"Sending {queueItem.Writer.Length} bytes: {ByteArrayToString(queueItem.Writer.ToArray(), 0, queueItem.Writer.Length)}");
                         m_Sender.Send(clientId, queueItem.NetworkDelivery, queueItem.Writer);
 
                         for (var hookIdx = 0; hookIdx < m_Hooks.Count; ++hookIdx)

com.unity.netcode.gameobjects/Runtime/Spawning/NetworkPrefabHandler.cs

@@ -1,5 +1,8 @@
 using System;
 using System.Collections.Generic;
+#if UNIFIED_NETCODE
+using Unity.NetCode;
+#endif
 using UnityEngine;
 
 namespace Unity.Netcode
@@ -418,6 +421,19 @@ public void AddNetworkPrefab(GameObject prefab)
             {
                 m_NetworkManager.DeferredMessageManager.ProcessTriggers(IDeferredNetworkMessageManager.TriggerType.OnAddPrefab, networkObject.GlobalObjectIdHash);
             }
+        
+#if UNIFIED_NETCODE
+            if (m_NetworkManager.IsListening)
+            {
+                var ghost = prefab.GetComponent<GhostAdapter>();
+                if (ghost)
+                {
+                    m_NetworkManager.InitializeNetcodeWorld();
+                    NetCode.Netcode.RegisterPrefabSingleWorld(prefab, m_NetworkManager.IsHost,
+                        m_NetworkManager.NetcodeWorld);
+                }
+            }
+#endif
         }
 
         /// <summary>

com.unity.netcode.gameobjects/Tests/Runtime/NetworkTransform/UnifiedNetworkTransformTest.cs

@@ -40,33 +40,9 @@ protected override IEnumerator OnSetup()
             // Creates the hybrid prefab
             m_Prefab = CreateHybridPrefab("HybridPrefab", true);
             m_Prefab.AddComponent<DoNothingNetworkTransform>();
-            NetworkSpawnManager.RegisterPendingGhost = RegisterPendingGhost;
             return base.OnSetup();
         }
-
-        protected override IEnumerator OnTearDown()
-        {
-            NetworkSpawnManager.RegisterPendingGhost = null;
-            m_EnableVerboseDebug = false;
-            return base.OnTearDown();
-        }
-
-        private void RegisterPendingGhost(NetworkObject networkObject, ulong networkObjectId)
-        {
-            var ghost = networkObject.GetComponent<GhostAdapter>();
-            Assert.IsNotNull(ghost, $"[RegisterPendingGhost][NetworkObject-{networkObjectId}] Has no {nameof(GhostAdapter)}!");
-            foreach (var networkManager in m_NetworkManagers)
-            {
-                // If the world matches, then register the instance with this NetworkManager's spawn manager.
-                if (networkManager.NetcodeWorld == ghost.World)
-                {
-                    networkManager.SpawnManager.RegisterGhostPendingSpawn(networkObject, networkObjectId);
-                    return;
-                }
-            }
-            Debug.LogError($"Did not find a world for NetworkObject-{networkObjectId}!!");
-        }
-
+        
         protected override void OnServerAndClientsCreated()
         {