feat: Addressables Redux

com.unity.netcode.gameobjects/CHANGELOG.md

@@ -28,6 +28,8 @@ Additional documentation and release notes are available at [Multiplayer Documen
 - Added `NetworkVariableWritePermission` to `NetworkVariableBase` and implemented `Owner` client writable netvars. (#1762)
 - `UnityTransport` settings can now be set programmatically. (#1845)
 - `FastBufferWriter` and Reader IsInitialized property. (#1859)
+- Prefabs can now be added to the network at **runtime** (i.e., from an addressable asset). If `ForceSamePrefabs` is false, this can happen after a connection has been formed. (#1882)
+- When `ForceSamePrefabs` is false, a configurable delay (default 1 second, configurable via `NetworkConfig.SpawnTimeout`) has been introduced to gracefully handle race conditions where a spawn call has been received for an object whose prefab is still being loaded. (#1882)
 
 ### Changed
 

com.unity.netcode.gameobjects/Runtime/Configuration/NetworkConfig.cs

@@ -128,10 +128,10 @@ public class NetworkConfig
         public int LoadSceneTimeOut = 120;
 
         /// <summary>
-        /// The amount of time a message should be buffered for without being consumed. If it is not consumed within this time, it will be dropped.
+        /// The amount of time a message should be buffered if the asset or object needed to process it doesn't exist yet. If the asset is not added/object is not spawned within this time, it will be dropped.
         /// </summary>
-        [Tooltip("The amount of time a message should be buffered for without being consumed. If it is not consumed within this time, it will be dropped")]
-        public float MessageBufferTimeout = 20f;
+        [Tooltip("The amount of time a message should be buffered if the asset or object needed to process it doesn't exist yet. If the asset is not added/object is not spawned within this time, it will be dropped")]
+        public float SpawnTimeout = 1f;
 
         /// <summary>
         /// Whether or not to enable network logs.

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

@@ -0,0 +1,65 @@
+using System;
+using System.Collections.Generic;
+
+namespace Unity.Netcode
+{
+    /// <summary>
+    /// This class is used to support testable code by allowing any supported component used by NetworkManager to be replaced
+    /// with a mock component or a test version that overloads certain methods to change or record their behavior.
+    /// Components currently supported by ComponentFactory:
+    /// - IDeferredMessageManager
+    /// </summary>
+    internal static class ComponentFactory
+    {
+        internal delegate object CreateObjectDelegate(NetworkManager networkManager);
+
+        private static Dictionary<Type, CreateObjectDelegate> s_Delegates = new Dictionary<Type, CreateObjectDelegate>();
+
+        /// <summary>
+        /// Instantiates an instance of a given interface
+        /// </summary>
+        /// <param name="networkManager">The network manager</param>
+        /// <typeparam name="T">The interface to instantiate it with</typeparam>
+        /// <returns></returns>
+        public static T Create<T>(NetworkManager networkManager)
+        {
+            return (T)s_Delegates[typeof(T)](networkManager);
+        }
+
+        /// <summary>
+        /// Overrides the default creation logic for a given interface type
+        /// </summary>
+        /// <param name="creator">The factory delegate to create the instance</param>
+        /// <typeparam name="T">The interface type to override</typeparam>
+        public static void Register<T>(CreateObjectDelegate creator)
+        {
+            s_Delegates[typeof(T)] = creator;
+        }
+
+        /// <summary>
+        /// Reverts the creation logic for a given interface type to the default logic
+        /// </summary>
+        /// <typeparam name="T">The interface type to revert</typeparam>
+        public static void Deregister<T>()
+        {
+            s_Delegates.Remove(typeof(T));
+            SetDefaults();
+        }
+
+        /// <summary>
+        /// Initializes the default creation logic for all supported component types
+        /// </summary>
+        public static void SetDefaults()
+        {
+            SetDefault<IDeferredMessageManager>(networkManager => new DeferredMessageManager(networkManager));
+        }
+
+        private static void SetDefault<T>(CreateObjectDelegate creator)
+        {
+            if (!s_Delegates.ContainsKey(typeof(T)))
+            {
+                s_Delegates[typeof(T)] = creator;
+            }
+        }
+    }
+}