com.unity.netcode.gameobjects@2.0.0-exp.4

The format is based on [Keep a Changelog](https://keepachangelog.com/en/1.0.0/) and this project adheres to [Semantic Versioning](https://semver.org/spec/v2.0.0.html). Additional documentation and release notes are available at [Multiplayer Documentation](https://docs-multiplayer.unity3d.com). ## [2.0.0-exp.4] - 2024-05-31 ### Added - Added `NetworkRigidbodyBase.AttachToFixedJoint` and `NetworkRigidbodyBase.DetachFromFixedJoint` to replace parenting for rigid bodies that have `NetworkRigidbodyBase.UseRigidBodyForMotion` enabled. (#2933) - Added `NetworkBehaviour.OnNetworkPreSpawn` and `NetworkBehaviour.OnNetworkPostSpawn` methods that provide the ability to handle pre and post spawning actions during the `NetworkObject` spawn sequence. (#2912) - Added a client-side only `NetworkBehaviour.OnNetworkSessionSynchronized` convenience method that is invoked on all `NetworkBehaviour`s after a newly joined client has finished synchronizing with the network session in progress. (#2912) - Added `NetworkBehaviour.OnInSceneObjectsSpawned` convenience method that is invoked when all in-scene `NetworkObject`s have been spawned after a scene has been loaded or upon a host or server starting. (#2912) ### Fixed - Fixed issue where non-authoritative rigid bodies with `NetworkRigidbodyBase.UseRigidBodyForMotion` enabled would constantly log errors about the renderTime being before `StartTimeConsumed`. (#2933) - Fixed issue where in-scene placed NetworkObjects could be destroyed if a client disconnects early and/or before approval. (#2924) - Fixed issue where a `NetworkObject` component's associated `NetworkBehaviour` components would not be detected if scene loading is disabled in the editor and the currently loaded scene has in-scene placed `NetworkObject`s. (#2912) - Fixed issue where an in-scene placed `NetworkObject` with `NetworkTransform` that is also parented under a `GameObject` would not properly synchronize when the parent `GameObject` had a world space position other than 0,0,0. (#2898) ### Changed - Change all the access modifiers of test class from Public to Internal (#2930) - Changed messages are now sorted by enum values as opposed to ordinally sorting the messages by their type name. (#2929) - Changed `NetworkClient.SessionModeTypes` to `NetworkClient.NetworkTopologyTypes`. (#2875) - Changed `NetworkClient.SessionModeType` to `NetworkClient.NetworkTopologyType`. (#2875) - Changed `NetworkConfig.SessionMode` to `NeworkConfig.NetworkTopology`. (#2875)
2024-05-31 00:00:00 +00:00
parent 143a6cbd34
commit 63c7e4c78a
177 changed files with 1792 additions and 820 deletions
--- a/Tests/Runtime/NetworkObject/NetworkObjectDestroyTests.cs
+++ b/Tests/Runtime/NetworkObject/NetworkObjectDestroyTests.cs
@@ -14,13 +14,13 @@ namespace Unity.Netcode.RuntimeTests
    /// - Client destroy spawned => throw exception.
    /// </summary>

-    [TestFixture(SessionModeTypes.DistributedAuthority)]
-    [TestFixture(SessionModeTypes.ClientServer)]
-    public class NetworkObjectDestroyTests : NetcodeIntegrationTest
+    [TestFixture(NetworkTopologyTypes.DistributedAuthority)]
+    [TestFixture(NetworkTopologyTypes.ClientServer)]
+    internal class NetworkObjectDestroyTests : NetcodeIntegrationTest
    {
        protected override int NumberOfClients => 2;

-        public NetworkObjectDestroyTests(SessionModeTypes sessionModeType) : base(sessionModeType) { }
+        public NetworkObjectDestroyTests(NetworkTopologyTypes networkTopologyType) : base(networkTopologyType) { }

        /// <summary>
        /// Tests that a server can destroy a NetworkObject and that it gets despawned correctly.
@@ -96,7 +96,7 @@ namespace Unity.Netcode.RuntimeTests
                }
                else
                {
-                    // Shutdown the 
+                    // Shutdown the
                    m_ClientNetworkManagers[0].Shutdown();
                }
            }
--- a/Tests/Runtime/NetworkObject/NetworkObjectDontDestroyWithOwnerTests.cs
+++ b/Tests/Runtime/NetworkObject/NetworkObjectDontDestroyWithOwnerTests.cs
@@ -11,7 +11,7 @@ namespace Unity.Netcode.RuntimeTests
    [TestFixture(HostOrServer.DAHost)]
    [TestFixture(HostOrServer.Host)]
    [TestFixture(HostOrServer.Server)]
-    public class NetworkObjectDontDestroyWithOwnerTests : NetcodeIntegrationTest
+    internal class NetworkObjectDontDestroyWithOwnerTests : NetcodeIntegrationTest
    {
        private const int k_NumberObjectsToSpawn = 32;
        protected override int NumberOfClients => 1;
--- a/Tests/Runtime/NetworkObject/NetworkObjectNetworkClientOwnedObjectsTests.cs
+++ b/Tests/Runtime/NetworkObject/NetworkObjectNetworkClientOwnedObjectsTests.cs
@@ -7,7 +7,7 @@ using UnityEngine.TestTools;

 namespace Unity.Netcode.RuntimeTests
 {
-    public class NetworkObjectNetworkClientOwnedObjectsTests : NetcodeIntegrationTest
+    internal class NetworkObjectNetworkClientOwnedObjectsTests : NetcodeIntegrationTest
    {
        private class DummyNetworkBehaviour : NetworkBehaviour
        {
--- a/Tests/Runtime/NetworkObject/NetworkObjectOnNetworkDespawnTests.cs
+++ b/Tests/Runtime/NetworkObject/NetworkObjectOnNetworkDespawnTests.cs
@@ -13,7 +13,7 @@ namespace Unity.Netcode.RuntimeTests
    [TestFixture(HostOrServer.DAHost)]
    [TestFixture(HostOrServer.Host)]
    [TestFixture(HostOrServer.Server)]
-    public class NetworkObjectOnNetworkDespawnTests : NetcodeIntegrationTest
+    internal class NetworkObjectOnNetworkDespawnTests : NetcodeIntegrationTest
    {
        private const string k_ObjectName = "TestDespawn";
        public enum InstanceTypes
--- a/Tests/Runtime/NetworkObject/NetworkObjectOnSpawnTests.cs
+++ b/Tests/Runtime/NetworkObject/NetworkObjectOnSpawnTests.cs
@@ -7,9 +7,9 @@ using UnityEngine.TestTools;

 namespace Unity.Netcode.RuntimeTests
 {
-    [TestFixture(SessionModeTypes.DistributedAuthority)]
-    [TestFixture(SessionModeTypes.ClientServer)]
-    public class NetworkObjectOnSpawnTests : NetcodeIntegrationTest
+    [TestFixture(NetworkTopologyTypes.DistributedAuthority)]
+    [TestFixture(NetworkTopologyTypes.ClientServer)]
+    internal class NetworkObjectOnSpawnTests : NetcodeIntegrationTest
    {
        private GameObject m_TestNetworkObjectPrefab;
        private GameObject m_TestNetworkObjectInstance;
@@ -29,7 +29,7 @@ namespace Unity.Netcode.RuntimeTests
        private const string k_WithObserversError = "Not all clients spawned the";
        private const string k_WithoutObserversError = "A client spawned the";

-        public NetworkObjectOnSpawnTests(SessionModeTypes sessionModeType) : base(sessionModeType) { }
+        public NetworkObjectOnSpawnTests(NetworkTopologyTypes networkTopologyType) : base(networkTopologyType) { }

        protected override void OnServerAndClientsCreated()
        {
@@ -43,7 +43,7 @@ namespace Unity.Netcode.RuntimeTests
            {
                if (m_ObserverTestType == ObserverTestTypes.WithObservers)
                {
-                    // When validating this portion of the test and spawning with observers is true, there 
+                    // When validating this portion of the test and spawning with observers is true, there
                    // should be spawned objects on the clients.
                    if (!s_GlobalNetworkObjects.ContainsKey(client.LocalClientId))
                    {
@@ -52,7 +52,7 @@ namespace Unity.Netcode.RuntimeTests
                }
                else
                {
-                    // When validating this portion of the test and spawning with observers is false, there 
+                    // When validating this portion of the test and spawning with observers is false, there
                    // should be no spawned objects on the clients.
                    if (s_GlobalNetworkObjects.ContainsKey(client.LocalClientId))
                    {
--- a/Tests/Runtime/NetworkObject/NetworkObjectOwnershipPropertiesTests.cs
+++ b/Tests/Runtime/NetworkObject/NetworkObjectOwnershipPropertiesTests.cs
@@ -8,9 +8,9 @@ using UnityEngine.TestTools;

 namespace Unity.Netcode.RuntimeTests
 {
-    [TestFixture(SessionModeTypes.DistributedAuthority)]
-    [TestFixture(SessionModeTypes.ClientServer)]
-    public class NetworkObjectOwnershipPropertiesTests : NetcodeIntegrationTest
+    [TestFixture(NetworkTopologyTypes.DistributedAuthority)]
+    [TestFixture(NetworkTopologyTypes.ClientServer)]
+    internal class NetworkObjectOwnershipPropertiesTests : NetcodeIntegrationTest
    {
        private class DummyNetworkBehaviour : NetworkBehaviour
        {
@@ -30,7 +30,7 @@ namespace Unity.Netcode.RuntimeTests
        private bool m_InitialOwnerOwnedBySever;
        private bool m_TargetOwnerOwnedBySever;

-        public NetworkObjectOwnershipPropertiesTests(SessionModeTypes sessionModeType) : base(sessionModeType) { }
+        public NetworkObjectOwnershipPropertiesTests(NetworkTopologyTypes networkTopologyType) : base(networkTopologyType) { }

        protected override IEnumerator OnTearDown()
        {
@@ -186,7 +186,7 @@ namespace Unity.Netcode.RuntimeTests
                yield return WaitForMessageReceived<ChangeOwnershipMessage>(m_ClientNetworkManagers.ToList());
            }

-            // Ensure it's the ownership tables are updated 
+            // Ensure it's the ownership tables are updated
            yield return WaitForConditionOrTimeOut(OwnershipPropagated);
            AssertOnTimeout($"Timed out waiting for ownership to propagate!\n{m_OwnershipPropagatedFailures}");

--- a/Tests/Runtime/NetworkObject/NetworkObjectOwnershipTests.cs
+++ b/Tests/Runtime/NetworkObject/NetworkObjectOwnershipTests.cs
@@ -8,7 +8,7 @@ using UnityEngine.TestTools;

 namespace Unity.Netcode.RuntimeTests
 {
-    public class NetworkObjectOwnershipComponent : NetworkBehaviour
+    internal class NetworkObjectOwnershipComponent : NetworkBehaviour
    {
        public static Dictionary<ulong, NetworkObjectOwnershipComponent> SpawnedInstances = new Dictionary<ulong, NetworkObjectOwnershipComponent>();

@@ -45,7 +45,7 @@ namespace Unity.Netcode.RuntimeTests
    [TestFixture(HostOrServer.DAHost)]
    [TestFixture(HostOrServer.Host)]
    [TestFixture(HostOrServer.Server)]
-    public class NetworkObjectOwnershipTests : NetcodeIntegrationTest
+    internal class NetworkObjectOwnershipTests : NetcodeIntegrationTest
    {
        protected override int NumberOfClients => 9;

--- a/Tests/Runtime/NetworkObject/NetworkObjectPropertyTests.cs
+++ b/Tests/Runtime/NetworkObject/NetworkObjectPropertyTests.cs
@@ -7,7 +7,7 @@ namespace Unity.Netcode.RuntimeTests
    /// <summary>
    /// Tests properties of NetworkObject for proper functionality.
    /// </summary>
-    public class NetworkObjectPropertyTests : NetcodeIntegrationTest
+    internal class NetworkObjectPropertyTests : NetcodeIntegrationTest
    {
        protected override int NumberOfClients => 1;

--- a/Tests/Runtime/NetworkObject/NetworkObjectSpawnManyObjectsTests.cs
+++ b/Tests/Runtime/NetworkObject/NetworkObjectSpawnManyObjectsTests.cs
@@ -7,9 +7,9 @@ using UnityEngine.TestTools;
 namespace Unity.Netcode.RuntimeTests
 {

-    [TestFixture(SessionModeTypes.ClientServer)]
-    [TestFixture(SessionModeTypes.DistributedAuthority)]
-    public class NetworkObjectSpawnManyObjectsTests : NetcodeIntegrationTest
+    [TestFixture(NetworkTopologyTypes.ClientServer)]
+    [TestFixture(NetworkTopologyTypes.DistributedAuthority)]
+    internal class NetworkObjectSpawnManyObjectsTests : NetcodeIntegrationTest
    {
        protected override int NumberOfClients => 1;
        // "many" in this case means enough to exceed a ushort_max message size written in the header
@@ -18,9 +18,9 @@ namespace Unity.Netcode.RuntimeTests

        private NetworkPrefab m_PrefabToSpawn;

-        public NetworkObjectSpawnManyObjectsTests(SessionModeTypes sessionModeType) : base(sessionModeType) { }
+        public NetworkObjectSpawnManyObjectsTests(NetworkTopologyTypes networkTopologyType) : base(networkTopologyType) { }
        // Using this component assures we will know precisely how many prefabs were spawned on the client
-        public class SpawnObjecTrackingComponent : NetworkBehaviour
+        internal class SpawnObjecTrackingComponent : NetworkBehaviour
        {
            public static int SpawnedObjects;
            public override void OnNetworkSpawn()
--- a/Tests/Runtime/NetworkObject/NetworkObjectSynchronizationTests.cs
+++ b/Tests/Runtime/NetworkObject/NetworkObjectSynchronizationTests.cs
@@ -14,7 +14,7 @@ namespace Unity.Netcode.RuntimeTests
    [TestFixture(VariableLengthSafety.EnabledNetVarSafety, HostOrServer.Host)]
    [TestFixture(VariableLengthSafety.DisableNetVarSafety, HostOrServer.Server)]
    [TestFixture(VariableLengthSafety.EnabledNetVarSafety, HostOrServer.Server)]
-    public class NetworkObjectSynchronizationTests : NetcodeIntegrationTest
+    internal class NetworkObjectSynchronizationTests : NetcodeIntegrationTest
    {
        private const int k_NumberToSpawn = 30;
        protected override int NumberOfClients => 0;
@@ -382,7 +382,7 @@ namespace Unity.Netcode.RuntimeTests
    /// the synchronization process will continue (i.e. it will skip over that block
    /// of the reader buffer).
    /// </summary>
-    public class NetworkBehaviourWithNetworkVariables : NetworkBehaviour
+    internal class NetworkBehaviourWithNetworkVariables : NetworkBehaviour
    {
        public static int ServerSpawnCount { get; internal set; }
        public static readonly Dictionary<ulong, int> ClientSpawnCount = new Dictionary<ulong, int>();
@@ -442,7 +442,7 @@ namespace Unity.Netcode.RuntimeTests
    /// when variable length safety checks are off NetworkVariables still are updated
    /// properly.
    /// </summary>
-    public class NetworkBehaviourWithOwnerNetworkVariables : NetworkBehaviour
+    internal class NetworkBehaviourWithOwnerNetworkVariables : NetworkBehaviour
    {
        private NetworkVariableWritePermission m_NetworkVariableWritePermission = NetworkVariableWritePermission.Server;
        /// <summary>
@@ -491,7 +491,7 @@ namespace Unity.Netcode.RuntimeTests
    /// and provides a synchronization success version to validate that synchronization
    /// will continue if user synchronization code fails.
    /// </summary>
-    public class NetworkBehaviourSynchronizeFailureComponent : NetworkBehaviour
+    internal class NetworkBehaviourSynchronizeFailureComponent : NetworkBehaviour
    {
        public static int NumberOfFailureTypes { get; internal set; }
        public static int ServerSpawnCount { get; internal set; }
@@ -661,11 +661,11 @@ namespace Unity.Netcode.RuntimeTests
        }
    }

-    public class NetworkBehaviourOnSynchronizeComponent : NetworkBehaviour
+    internal class NetworkBehaviourOnSynchronizeComponent : NetworkBehaviour
    {
        public SomeCustomSerializationData CustomSerializationData = new SomeCustomSerializationData();

-        public struct SomeCustomSerializationData : INetworkSerializable
+        internal struct SomeCustomSerializationData : INetworkSerializable
        {
            public uint Value1;
            public bool Value2;