com.unity.netcode.gameobjects@1.1.0

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). ## [1.1.0] - 2022-10-21 ### Added - Added `NetworkManager.IsApproved` flag that is set to `true` a client has been approved.(#2261) - `UnityTransport` now provides a way to set the Relay server data directly from the `RelayServerData` structure (provided by the Unity Transport package) throuh its `SetRelayServerData` method. This allows making use of the new APIs in UTP 1.3 that simplify integration of the Relay SDK. (#2235) - IPv6 is now supported for direct connections when using `UnityTransport`. (#2232) - Added WebSocket support when using UTP 2.0 with `UseWebSockets` property in the `UnityTransport` component of the `NetworkManager` allowing to pick WebSockets for communication. When building for WebGL, this selection happens automatically. (#2201) - Added position, rotation, and scale to the `ParentSyncMessage` which provides users the ability to specify the final values on the server-side when `OnNetworkObjectParentChanged` is invoked just before the message is created (when the `Transform` values are applied to the message). (#2146) - Added `NetworkObject.TryRemoveParent` method for convenience purposes opposed to having to cast null to either `GameObject` or `NetworkObject`. (#2146) ### Changed - Updated `UnityTransport` dependency on `com.unity.transport` to 1.3.0. (#2231) - The send queues of `UnityTransport` are now dynamically-sized. This means that there shouldn't be any need anymore to tweak the 'Max Send Queue Size' value. In fact, this field is now removed from the inspector and will not be serialized anymore. It is still possible to set it manually using the `MaxSendQueueSize` property, but it is not recommended to do so aside from some specific needs (e.g. limiting the amount of memory used by the send queues in very constrained environments). (#2212) - As a consequence of the above change, the `UnityTransport.InitialMaxSendQueueSize` field is now deprecated. There is no default value anymore since send queues are dynamically-sized. (#2212) - The debug simulator in `UnityTransport` is now non-deterministic. Its random number generator used to be seeded with a constant value, leading to the same pattern of packet drops, delays, and jitter in every run. (#2196) - `NetworkVariable<>` now supports managed `INetworkSerializable` types, as well as other managed types with serialization/deserialization delegates registered to `UserNetworkVariableSerialization<T>.WriteValue` and `UserNetworkVariableSerialization<T>.ReadValue` (#2219) - `NetworkVariable<>` and `BufferSerializer<BufferSerializerReader>` now deserialize `INetworkSerializable` types in-place, rather than constructing new ones. (#2219) ### Fixed - Fixed `NetworkManager.ApprovalTimeout` will not timeout due to slower client synchronization times as it now uses the added `NetworkManager.IsApproved` flag to determined if the client has been approved or not.(#2261) - Fixed issue caused when changing ownership of objects hidden to some clients (#2242) - Fixed issue where an in-scene placed NetworkObject would not invoke NetworkBehaviour.OnNetworkSpawn if the GameObject was disabled when it was despawned. (#2239) - Fixed issue where clients were not rebuilding the `NetworkConfig` hash value for each unique connection request. (#2226) - Fixed the issue where player objects were not taking the `DontDestroyWithOwner` property into consideration when a client disconnected. (#2225) - Fixed issue where `SceneEventProgress` would not complete if a client late joins while it is still in progress. (#2222) - Fixed issue where `SceneEventProgress` would not complete if a client disconnects. (#2222) - Fixed issues with detecting if a `SceneEventProgress` has timed out. (#2222) - Fixed issue #1924 where `UnityTransport` would fail to restart after a first failure (even if what caused the initial failure was addressed). (#2220) - Fixed issue where `NetworkTransform.SetStateServerRpc` and `NetworkTransform.SetStateClientRpc` were not honoring local vs world space settings when applying the position and rotation. (#2203) - Fixed ILPP `TypeLoadException` on WebGL on MacOS Editor and potentially other platforms. (#2199) - Implicit conversion of NetworkObjectReference to GameObject will now return null instead of throwing an exception if the referenced object could not be found (i.e., was already despawned) (#2158) - Fixed warning resulting from a stray NetworkAnimator.meta file (#2153) - Fixed Connection Approval Timeout not working client side. (#2164) - Fixed issue where the `WorldPositionStays` parenting parameter was not being synchronized with clients. (#2146) - Fixed issue where parented in-scene placed `NetworkObject`s would fail for late joining clients. (#2146) - Fixed issue where scale was not being synchronized which caused issues with nested parenting and scale when `WorldPositionStays` was true. (#2146) - Fixed issue with `NetworkTransform.ApplyTransformToNetworkStateWithInfo` where it was not honoring axis sync settings when `NetworkTransformState.IsTeleportingNextFrame` was true. (#2146) - Fixed issue with `NetworkTransform.TryCommitTransformToServer` where it was not honoring the `InLocalSpace` setting. (#2146) - Fixed ClientRpcs always reporting in the profiler view as going to all clients, even when limited to a subset of clients by `ClientRpcParams`. (#2144) - Fixed RPC codegen failing to choose the correct extension methods for `FastBufferReader` and `FastBufferWriter` when the parameters were a generic type (i.e., List<int>) and extensions for multiple instantiations of that type have been defined (i.e., List<int> and List<string>) (#2142) - Fixed the issue where running a server (i.e. not host) the second player would not receive updates (unless a third player joined). (#2127) - Fixed issue where late-joining client transition synchronization could fail when more than one transition was occurring.(#2127) - Fixed throwing an exception in `OnNetworkUpdate` causing other `OnNetworkUpdate` calls to not be executed. (#1739) - Fixed synchronization when Time.timeScale is set to 0. This changes timing update to use unscaled deltatime. Now network updates rate are independent from the local time scale. (#2171) - Fixed not sending all NetworkVariables to all clients when a client connects to a server. (#1987) - Fixed IsOwner/IsOwnedByServer being wrong on the server after calling RemoveOwnership (#2211)
2022-10-21 00:00:00 +00:00
parent a6969670f5
commit 1e7078c160
97 changed files with 6175 additions and 1643 deletions
--- a/Tests/Runtime/Timing/NetworkTimeSystemTests.cs
+++ b/Tests/Runtime/Timing/NetworkTimeSystemTests.cs
@@ -1,6 +1,7 @@
 using System.Collections;
 using NUnit.Framework;
 using UnityEngine;
+using UnityEngine.Assertions.Comparers;
 using UnityEngine.TestTools;
 using Unity.Netcode.TestHelpers.Runtime;

@@ -11,25 +12,45 @@ namespace Unity.Netcode.RuntimeTests
    /// </summary>
    public class NetworkTimeSystemTests
    {
-        private MonoBehaviourTest<PlayerLoopTimeTestComponent> m_MonoBehaviourTest; // cache for teardown
+        private MonoBehaviourTest<PlayerLoopFixedTimeTestComponent> m_PlayerLoopFixedTimeTestComponent; // cache for teardown
+        private MonoBehaviourTest<PlayerLoopTimeTestComponent> m_PlayerLoopTimeTestComponent; // cache for teardown
+
+        private float m_OriginalTimeScale = 1.0f;

        [SetUp]
        public void Setup()
        {
+            m_OriginalTimeScale = Time.timeScale;
+
            // Create, instantiate, and host
            Assert.IsTrue(NetworkManagerHelper.StartNetworkManager(out _));
        }

        /// <summary>
        /// Tests whether time is accessible and has correct values inside Update/FixedUpdate.
+        /// This test applies only when <see cref="Time.timeScale"> is 1.
        /// </summary>
        /// <returns></returns>
        [UnityTest]
-        public IEnumerator PlayerLoopTimeTest()
+        public IEnumerator PlayerLoopFixedTimeTest()
        {
-            m_MonoBehaviourTest = new MonoBehaviourTest<PlayerLoopTimeTestComponent>();
+            m_PlayerLoopFixedTimeTestComponent = new MonoBehaviourTest<PlayerLoopFixedTimeTestComponent>();

-            yield return m_MonoBehaviourTest;
+            yield return m_PlayerLoopFixedTimeTestComponent;
+        }
+
+        /// <summary>
+        /// Tests whether time is accessible and has correct values inside Update, for multiples <see cref="Time.timeScale"/> values.
+        /// </summary>
+        /// <returns></returns>
+        [UnityTest]
+        public IEnumerator PlayerLoopTimeTest_WithDifferentTimeScale([Values(0.0f, 0.1f, 0.5f, 1.0f, 2.0f, 5.0f)] float timeScale)
+        {
+            Time.timeScale = timeScale;
+
+            m_PlayerLoopTimeTestComponent = new MonoBehaviourTest<PlayerLoopTimeTestComponent>();
+
+            yield return m_PlayerLoopTimeTestComponent;
        }

        /// <summary>
@@ -40,10 +61,10 @@ namespace Unity.Netcode.RuntimeTests
        [UnityTest]
        public IEnumerator CorrectAmountTicksTest()
        {
-            var tickSystem = NetworkManager.Singleton.NetworkTickSystem;
-            var delta = tickSystem.LocalTime.FixedDeltaTime;
-            var previous_localTickCalculated = 0;
-            var previous_serverTickCalculated = 0;
+            NetworkTickSystem tickSystem = NetworkManager.Singleton.NetworkTickSystem;
+            float delta = tickSystem.LocalTime.FixedDeltaTime;
+            int previous_localTickCalculated = 0;
+            int previous_serverTickCalculated = 0;

            while (tickSystem.LocalTime.Time < 3f)
            {
@@ -70,7 +91,7 @@ namespace Unity.Netcode.RuntimeTests

                Assert.AreEqual(previous_localTickCalculated, NetworkManager.Singleton.LocalTime.Tick, $"Calculated local tick {previous_localTickCalculated} does not match local tick {NetworkManager.Singleton.LocalTime.Tick}!");
                Assert.AreEqual(previous_serverTickCalculated, NetworkManager.Singleton.ServerTime.Tick, $"Calculated server tick {previous_serverTickCalculated} does not match server tick {NetworkManager.Singleton.ServerTime.Tick}!");
-                Assert.True(Mathf.Approximately((float)NetworkManager.Singleton.LocalTime.Time, (float)NetworkManager.Singleton.ServerTime.Time), $"Local time {(float)NetworkManager.Singleton.LocalTime.Time} is not approximately server time {(float)NetworkManager.Singleton.ServerTime.Time}!");
+                Assert.AreEqual((float)NetworkManager.Singleton.LocalTime.Time, (float)NetworkManager.Singleton.ServerTime.Time, $"Local time {(float)NetworkManager.Singleton.LocalTime.Time} is not approximately server time {(float)NetworkManager.Singleton.ServerTime.Time}!", FloatComparer.s_ComparerWithDefaultTolerance);
            }
        }

@@ -80,15 +101,23 @@ namespace Unity.Netcode.RuntimeTests
            // Stop, shutdown, and destroy
            NetworkManagerHelper.ShutdownNetworkManager();

-            if (m_MonoBehaviourTest != null)
+            Time.timeScale = m_OriginalTimeScale;
+
+            if (m_PlayerLoopFixedTimeTestComponent != null)
            {
-                Object.DestroyImmediate(m_MonoBehaviourTest.gameObject);
+                Object.DestroyImmediate(m_PlayerLoopFixedTimeTestComponent.gameObject);
+                m_PlayerLoopFixedTimeTestComponent = null;
+            }
+
+            if (m_PlayerLoopTimeTestComponent != null)
+            {
+                Object.DestroyImmediate(m_PlayerLoopTimeTestComponent.gameObject);
+                m_PlayerLoopTimeTestComponent = null;
            }
        }
-
    }

-    public class PlayerLoopTimeTestComponent : MonoBehaviour, IMonoBehaviourTest
+    public class PlayerLoopFixedTimeTestComponent : MonoBehaviour, IMonoBehaviourTest
    {
        public const int Passes = 100;

@@ -101,7 +130,7 @@ namespace Unity.Netcode.RuntimeTests
        private NetworkTime m_ServerTimePreviousUpdate;
        private NetworkTime m_LocalTimePreviousFixedUpdate;

-        public void Start()
+        private void Start()
        {
            // Run fixed update at same rate as network tick
            Time.fixedDeltaTime = NetworkManager.Singleton.LocalTime.FixedDeltaTime;
@@ -110,23 +139,23 @@ namespace Unity.Netcode.RuntimeTests
            Time.maximumDeltaTime = float.MaxValue;
        }

-        public void Update()
+        private void Update()
        {
            // This must run first else it wont run if there is an exception
            m_UpdatePasses++;

-            var localTime = NetworkManager.Singleton.LocalTime;
-            var serverTime = NetworkManager.Singleton.ServerTime;
+            NetworkTime localTime = NetworkManager.Singleton.LocalTime;
+            NetworkTime serverTime = NetworkManager.Singleton.ServerTime;

            // time should have advanced on the host/server
-            Assert.True(m_LocalTimePreviousUpdate.Time < localTime.Time);
-            Assert.True(m_ServerTimePreviousUpdate.Time < serverTime.Time);
+            Assert.Less(m_LocalTimePreviousUpdate.Time, localTime.Time);
+            Assert.Less(m_ServerTimePreviousUpdate.Time, serverTime.Time);

            // time should be further then last fixed step in update
-            Assert.True(m_LocalTimePreviousFixedUpdate.FixedTime < localTime.Time);
+            Assert.Less(m_LocalTimePreviousFixedUpdate.FixedTime, localTime.Time);

            // we should be in same or further tick then fixed update
-            Assert.True(m_LocalTimePreviousFixedUpdate.Tick <= localTime.Tick);
+            Assert.LessOrEqual(m_LocalTimePreviousFixedUpdate.Tick, localTime.Tick);

            // fixed update should result in same amounts of tick as network time
            if (m_TickOffset == -1)
@@ -135,26 +164,64 @@ namespace Unity.Netcode.RuntimeTests
            }
            else
            {
-                // offset of  1 is ok, this happens due to different tick duration offsets
-                Assert.True(Mathf.Abs(serverTime.Tick - m_TickOffset - m_LastFixedUpdateTick) <= 1);
+                // offset of 1 is ok, this happens due to different tick duration offsets
+                Assert.LessOrEqual(Mathf.Abs(serverTime.Tick - m_TickOffset - m_LastFixedUpdateTick), 1);
            }

            m_LocalTimePreviousUpdate = localTime;
+            m_ServerTimePreviousUpdate = serverTime;
        }

-        public void FixedUpdate()
+        private void FixedUpdate()
        {
-            var time = NetworkManager.Singleton.LocalTime;
-
-            m_LocalTimePreviousFixedUpdate = time;
-
-            Assert.AreEqual(Time.fixedDeltaTime, time.FixedDeltaTime);
-            Assert.True(Mathf.Approximately((float)NetworkManager.Singleton.LocalTime.Time, (float)NetworkManager.Singleton.ServerTime.Time));
+            m_LocalTimePreviousFixedUpdate = NetworkManager.Singleton.LocalTime;

+            Assert.AreEqual(Time.fixedDeltaTime, m_LocalTimePreviousFixedUpdate.FixedDeltaTime);
+            Assert.AreEqual((float)NetworkManager.Singleton.LocalTime.Time, (float)NetworkManager.Singleton.ServerTime.Time, null, FloatComparer.s_ComparerWithDefaultTolerance);
            m_LastFixedUpdateTick++;
        }

        public bool IsTestFinished => m_UpdatePasses >= Passes;
    }

+    public class PlayerLoopTimeTestComponent : MonoBehaviour, IMonoBehaviourTest
+    {
+        public const int Passes = 100;
+
+        private int m_UpdatePasses = 0;
+
+        private NetworkTime m_LocalTimePreviousUpdate;
+        private NetworkTime m_ServerTimePreviousUpdate;
+        private NetworkTime m_LocalTimePreviousFixedUpdate;
+
+        private void Update()
+        {
+            // This must run first else it wont run if there is an exception
+            m_UpdatePasses++;
+
+            NetworkTime localTime = NetworkManager.Singleton.LocalTime;
+            NetworkTime serverTime = NetworkManager.Singleton.ServerTime;
+
+            // time should have advanced on the host/server
+            Assert.Less(m_LocalTimePreviousUpdate.Time, localTime.Time);
+            Assert.Less(m_ServerTimePreviousUpdate.Time, serverTime.Time);
+
+            // time should be further then last fixed step in update
+            Assert.Less(m_LocalTimePreviousFixedUpdate.FixedTime, localTime.Time);
+
+            // we should be in same or further tick then fixed update
+            Assert.LessOrEqual(m_LocalTimePreviousFixedUpdate.Tick, localTime.Tick);
+
+            m_LocalTimePreviousUpdate = localTime;
+            m_ServerTimePreviousUpdate = serverTime;
+        }
+
+        private void FixedUpdate()
+        {
+            m_LocalTimePreviousFixedUpdate = NetworkManager.Singleton.LocalTime;
+        }
+
+        public bool IsTestFinished => m_UpdatePasses >= Passes;
+    }
+
 }