Merge branch 'develop' into docs/toc-changes-backport

Author: NoelStephensUnity

.yamato/_run-all.yml

@@ -10,6 +10,7 @@
 
 #-----------------------------------------------------------------------------------
 
+
 # This job runs the fastest checks (PVP and code standards)
 # This is mainly used to quickly validate the easy mistakes before for example running PR trigger jobs (see _triggers.yml)
 run_quick_checks:

.yamato/code-coverage.yml

@@ -38,7 +38,7 @@ code_coverage_{{ platform.name }}_{{ editor }}:
   commands:
     - unity-downloader-cli --fast --wait -u {{ editor }} -c Editor {% if platform.name == "mac" %} --arch arm64 {% endif %} # For macOS we use ARM64 models
     - upm-pvp create-test-project test-project --packages "upm-ci~/packages/*.tgz" --unity .Editor
-    - UnifiedTestRunner --suite=editor --suite=playmode --editor-location=.Editor --testproject=test-project --enable-code-coverage coverage-upload-options="reportsDir:$PWD/test-results/CoverageResults;name:NGOv1_{{ platform.name }}_{{ editor }};flags:NGOv1_{{ platform.name }}_{{ editor }};verbose" --coverage-results-path=$PWD/test-results/CoverageResults --coverage-options="generateHtmlReport;generateAdditionalMetrics;assemblyFilters:+Unity.Netcode.Editor,+Unity.Netcode.Runtime" --extra-editor-arg=--burst-disable-compilation --timeout={ test_timeout }} --rerun-strategy=Test --retry={{ num_test_retries }} --clean-library-on-rerun --artifacts-path=test-results
+    - UnifiedTestRunner --suite=editor --suite=playmode --editor-location=.Editor --testproject=test-project --enable-code-coverage coverage-upload-options="reportsDir:$PWD/test-results/CoverageResults;name:NGOv1_{{ platform.name }}_{{ editor }};flags:NGOv1_{{ platform.name }}_{{ editor }};verbose" --coverage-results-path=$PWD/test-results/CoverageResults --coverage-options="generateHtmlReport;generateAdditionalMetrics;assemblyFilters:+Unity.Netcode.Editor,+Unity.Netcode.Runtime" --extra-editor-arg=--burst-disable-compilation --timeout={{ test_timeout }} --rerun-strategy=Test --retry={{ num_test_retries }} --clean-library-on-rerun --artifacts-path=test-results
   artifacts:
     logs:
       paths:

.yamato/project-builders/project-builders.yml

@@ -34,7 +34,7 @@ build_{{ netcodeProject[0] }}_project:
   commands:
     # Validate inputs passed via Yamato variables
     - python Tools/scripts/BuildAutomation/validate_params.py
-    - echo Building {{ netcodeProject[0] }} project from branch {{ netcodeProject[1].defaultBranch }} with Unity version of %UNITY_VERSION%, Scripting backend %SCRIPTING_BACKEND_IL2CPP_MONO%, Burst %BURST_ON_OFF% for platform %PLATFORM_WIN64_MAC_ANDROID%
+    - echo Building {{ netcodeProject[0] }} project from branch %SAMPLE_BRANCH% with Unity version of %UNITY_VERSION%, Scripting backend %SCRIPTING_BACKEND_IL2CPP_MONO%, Burst %BURST_ON_OFF% for platform %PLATFORM_WIN64_MAC_ANDROID%
 
     # Clone the external project repository into a specific directory. Notice that branch is also specified.
     - git clone --single-branch --branch %SAMPLE_BRANCH% {{ netcodeProject[1].GithubRepo }} C:/ClonedProject

com.unity.netcode.gameobjects/CHANGELOG.md

@@ -13,6 +13,7 @@ Additional documentation and release notes are available at [Multiplayer Documen
 
 ### Changed
 
+- Better error message when using generic IEquatable in a generic INetworkSerializable class and updated documentation with workaround. (#3744)
 - The `NetworkManager` functions `GetTransportIdFromClientId` and `GetClientIdFromTransportId` will now return `ulong.MaxValue` when the clientId or transportId do not exist. (#3721)
 - Changed minimum Unity version supported to 2022.3 LTS
 
@@ -25,6 +26,7 @@ Additional documentation and release notes are available at [Multiplayer Documen
 ### Fixed
 
 - Multiple disconnect events from the same transport will no longer disconnect the host. (#3721)
+- Exception when the network prefab list in the network manager has uninitialized elements. (#3744)
 
 ### Security
 

com.unity.netcode.gameobjects/Documentation~/advanced-topics/serialization/inetworkserializable.md

@@ -181,3 +181,55 @@ public struct MyStructB : MyStructA
     }
 }
 ```
+
+## Generic IEquatable network variables
+
+Netcode for GameObjects doesn't support generic `INetworkSerializable` types with generic `IEquatable`s when implemented as `public class NotSupported<T> : INetworkSerializable, IEquatable<NotSupported<T>>`, where the type is passed in during declaration like `NetworkVariable<NotSupported<int>> myVar;`.
+
+You can work around this limitation by creating the generic class as normal and adding a virtual method for handling the serialization of the type. Then wrap the generic `INetworkSerializable` in a derived class that has a serializable type defined where the implementation for the serialization is provided.
+
+For example:
+
+```csharp
+public class MyGameData<T> : INetworkSerializable
+{
+    // This needs to be a serializable type according to what network variables support
+    public T Data;
+
+    protected virtual void OnNetworkSerialize<T2>(BufferSerializer<T2> serializer) where T2 : IReaderWriter
+    {
+    }
+
+    public void NetworkSerialize<T2>(BufferSerializer<T2> serializer) where T2 : IReaderWriter
+    {
+        OnNetworkSerialize(serializer);
+    }
+}
+
+public class GameDataWithLong : MyGameData<long>, IEquatable<GameDataWithLong>
+{
+    // Potential additional data
+    public int AdditionalData;
+
+    protected virtual bool OnEquals(GameDataWithLong other)
+    {
+        return other.Data.Equals(other);
+    }
+    public bool Equals(GameDataWithLong other)
+    {
+        return OnEquals(other);
+    }
+
+    protected override void OnNetworkSerialize<T2>(BufferSerializer<T2> serializer)
+    {
+        serializer.SerializeValue(ref AdditionalData);
+        serializer.SerializeValue(ref Data);
+    }
+}
+```
+
+Then declare this network variable like so:
+
+```csharp
+NetworkVariable<GameDataWithLong> myVar = new NetworkVariable<GameDataWithLong>();
+```

com.unity.netcode.gameobjects/Editor/CodeGen/NetworkBehaviourILPP.cs

@@ -408,7 +408,14 @@ private void CreateNetworkVariableTypeInitializers(AssemblyDefinition assembly,
                     }
                     else
                     {
-                        m_Diagnostics.AddError($"{type}: Managed type in NetworkVariable must implement IEquatable<{type}>");
+                        foreach (var typeInterface in type.Resolve().Interfaces)
+                        {
+                            if (typeInterface.InterfaceType.Name.Contains(typeof(IEquatable<>).Name) && typeInterface.InterfaceType.IsGenericInstance)
+                            {
+                                m_Diagnostics.AddError($"{type}: A generic IEquatable '{typeInterface.InterfaceType.FullName}' is not supported.");
+                            }
+                        }
+                        m_Diagnostics.AddError($"{type}: Managed type in NetworkVariable must implement IEquatable<{type}>.");
                         equalityMethod = new GenericInstanceMethod(m_NetworkVariableSerializationTypes_InitializeEqualityChecker_ManagedClassEquals_MethodRef);
                     }
 

com.unity.netcode.gameobjects/Editor/NetworkManagerEditor.cs

@@ -4,6 +4,7 @@
 using System;
 using System.Collections.Generic;
 using System.IO;
+using System.Linq;
 using Unity.Netcode.Editor.Configuration;
 using UnityEditor;
 using UnityEngine;
@@ -539,6 +540,10 @@ private void DrawPrefabListField()
                 {
                     EditorGUILayout.HelpBox("You have no prefab list selected. You will have to add your prefabs manually at runtime for netcode to work.", MessageType.Warning);
                 }
+                else if (m_NetworkManager.NetworkConfig.Prefabs.NetworkPrefabsLists.All(x => x == null))
+                {
+                    EditorGUILayout.HelpBox("All prefab lists selected are uninitialized. You will have to add your prefabs manually at runtime for netcode to work.", MessageType.Warning);
+                }
 
                 EditorGUILayout.PropertyField(m_PrefabsList);
                 return;

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

@@ -93,6 +93,7 @@ internal void Shutdown()
         public void Initialize(bool warnInvalid = true)
         {
             m_Prefabs.Clear();
+            NetworkPrefabsLists.RemoveAll(x => x == null);
             foreach (var list in NetworkPrefabsLists)
             {
                 list.OnAdd += AddTriggeredByNetworkPrefabList;

com.unity.netcode.gameobjects/Runtime/HelpUrls.cs

@@ -10,8 +10,8 @@ internal static class HelpUrls
         public const string NetworkManager = k_BaseManualUrl + "components/core/networkmanager.html";
         public const string NetworkObject = k_BaseManualUrl + "components/core/networkobject.html";
         public const string NetworkAnimator = k_BaseManualUrl + "components/helper/networkanimator.html";
-        public const string NetworkRigidbody = k_BaseManualUrl + "advanced-topics/physics.html#networkrigidbody";
-        public const string NetworkRigidbody2D = k_BaseManualUrl + "advanced-topics/physics.html#networkrigidbody2d";
+        public const string NetworkRigidbody = k_BaseManualUrl + "components/helper/networkrigidbody.html";
+        public const string NetworkRigidbody2D = k_BaseManualUrl + "components/helper/networkrigidbody.html#networkrigidbody2d";
         public const string NetworkTransform = k_BaseManualUrl + "components/helper/networktransform.html";
         public const string AnticipatedNetworkTransform = k_BaseManualUrl + "advanced-topics/client-anticipation.html";
         public const string UnityTransport = k_BaseApiUrl + ".Transports.UTP.UnityTransport.html";

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

@@ -1048,7 +1048,10 @@ private void ExtractNetworkMetrics()
                         continue;
                     }
                     var transportClientId = NetworkManager.ConnectionManager.ClientIdToTransportId(ngoConnectionId);
-                    ExtractNetworkMetricsForClient(transportClientId);
+                    if (transportClientId.Item2)
+                    {
+                        ExtractNetworkMetricsForClient(transportClientId.Item1);
+                    }
                 }
             }
             else