feat: Make custom driver construction smoother

Author: simon-lemay-unity

com.unity.netcode.gameobjects/CHANGELOG.md

@@ -10,9 +10,11 @@ Additional documentation and release notes are available at [Multiplayer Documen
 
 ### Added
 
+- Added a new variant of `UnityTransport.GetDefaultPipelineConfigurations` that takes a reference to the created `NetworkDriver`. This will register all pipeline stages that `UnityTransport` requires, removing the need to manually register them in your own custom driver constructor.
 
 ### Changed
 
+- `NetworkMetricsPipelineStage` is now defined even when the multiplayer tools package is not installed, removing the need to guard its registration behind a version define when using a custom driver in `UnityTransport`.
 
 ### Deprecated
 

com.unity.netcode.gameobjects/Runtime/Transports/UTP/INetworkStreamDriverConstructor.cs

@@ -36,9 +36,8 @@ namespace Unity.Netcode.Transports.UTP
     ///             var settings = transport.GetDefaultNetworkSettings();
     ///             driver = NetworkDriver.Create(new IPCNetworkInterface(), settings);
     ///
-    ///             driver.RegisterPipelineStage(new NetworkMetricsPipelineStage());
-    ///
     ///             transport.GetDefaultPipelineConfigurations(
+    ///                 ref driver,
     ///                 out var unreliableFragmentedPipelineStages,
     ///                 out var unreliableSequencedFragmentedPipelineStages,
     ///                 out var reliableSequencedPipelineStages);

com.unity.netcode.gameobjects/Runtime/Transports/UTP/NetworkMetricsPipelineStage.cs

@@ -1,5 +1,3 @@
-#if MULTIPLAYER_TOOLS
-#if MULTIPLAYER_TOOLS_1_0_0_PRE_7
 using AOT;
 using Unity.Burst;
 using Unity.Collections.LowLevel.Unsafe;
@@ -70,5 +68,3 @@ private static void InitializeConnection(byte* staticInstanceBuffer, int staticI
         }
     }
 }
-#endif
-#endif

com.unity.netcode.gameobjects/Runtime/Transports/UTP/UnityTransport.cs

@@ -657,6 +657,23 @@ public void GetDefaultPipelineConfigurations(
             reliableSequencedPipelineStages = new(reliableSequenced, Allocator.Temp);
         }
 
+        /// <inheritdoc cref="GetDefaultPipelineConfigurations(out NativeArray{NetworkPipelineStageId}, out NativeArray{NetworkPipelineStageId}, out NativeArray{NetworkPipelineStageId})"/>
+        /// <param name="driver">Driver for which the pipeline configurations are being retrieved.</param>
+        public void GetDefaultPipelineConfigurations(
+            ref NetworkDriver driver,
+            out NativeArray<NetworkPipelineStageId> unreliableFragmentedPipelineStages,
+            out NativeArray<NetworkPipelineStageId> unreliableSequencedFragmentedPipelineStages,
+            out NativeArray<NetworkPipelineStageId> reliableSequencedPipelineStages)
+        {
+#if MULTIPLAYER_TOOLS_1_0_0_PRE_7
+            driver.RegisterPipelineStage(new NetworkMetricsPipelineStage());
+#endif
+            GetDefaultPipelineConfigurations(
+                out unreliableFragmentedPipelineStages,
+                out unreliableSequencedFragmentedPipelineStages,
+                out reliableSequencedPipelineStages);
+        }
+
         private NetworkPipeline SelectSendPipeline(NetworkDelivery delivery)
         {
             switch (delivery)
@@ -1860,11 +1877,8 @@ public void CreateDriver(
 #endif
             }
 
-#if MULTIPLAYER_TOOLS_1_0_0_PRE_7
-            driver.RegisterPipelineStage(new NetworkMetricsPipelineStage());
-#endif
-
             GetDefaultPipelineConfigurations(
+                ref driver,
                 out var unreliableFragmentedPipelineStages,
                 out var unreliableSequencedFragmentedPipelineStages,
                 out var reliableSequencedPipelineStages);