com.unity.netcode.gameobjects@1.5.1

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.5.1] - 2023-06-07 ### Added - Added support for serializing `NativeArray<>` and `NativeList<>` in `FastBufferReader`/`FastBufferWriter`, `BufferSerializer`, `NetworkVariable`, and RPCs. (To use `NativeList<>`, add `UNITY_NETCODE_NATIVE_COLLECTION_SUPPORT` to your Scripting Define Symbols in `Project Settings > Player`) (#2375) - The location of the automatically-created default network prefab list can now be configured (#2544) - Added: Message size limits (max single message and max fragmented message) can now be set using NetworkManager.MaximumTransmissionUnitSize and NetworkManager.MaximumFragmentedMessageSize for transports that don't work with the default values (#2530) - Added `NetworkObject.SpawnWithObservers` property (default is true) that when set to false will spawn a `NetworkObject` with no observers and will not be spawned on any client until `NetworkObject.NetworkShow` is invoked. (#2568) ### Fixed - Fixed: Fixed a null reference in codegen in some projects (#2581) - Fixed issue where the `OnClientDisconnected` client identifier was incorrect after a pending client connection was denied. (#2569) - Fixed warning "Runtime Network Prefabs was not empty at initialization time." being erroneously logged when no runtime network prefabs had been added (#2565) - Fixed issue where some temporary debug console logging was left in a merged PR. (#2562) - Fixed the "Generate Default Network Prefabs List" setting not loading correctly and always reverting to being checked. (#2545) - Fixed issue where users could not use NetworkSceneManager.VerifySceneBeforeLoading to exclude runtime generated scenes from client synchronization. (#2550) - Fixed missing value on `NetworkListEvent` for `EventType.RemoveAt` events. (#2542,#2543) - Fixed issue where parenting a NetworkTransform under a transform with a scale other than Vector3.one would result in incorrect values on non-authoritative instances. (#2538) - Fixed issue where a server would include scene migrated and then despawned NetworkObjects to a client that was being synchronized. (#2532) - Fixed the inspector throwing exceptions when attempting to render `NetworkVariable`s of enum types. (#2529) - Making a `NetworkVariable` with an `INetworkSerializable` type that doesn't meet the `new()` constraint will now create a compile-time error instead of an editor crash (#2528) - Fixed Multiplayer Tools package installation docs page link on the NetworkManager popup. (#2526) - Fixed an exception and error logging when two different objects are shown and hidden on the same frame (#2524) - Fixed a memory leak in `UnityTransport` that occurred if `StartClient` failed. (#2518) - Fixed issue where a client could throw an exception if abruptly disconnected from a network session with one or more spawned `NetworkObject`(s). (#2510) - Fixed issue where invalid endpoint addresses were not being detected and returning false from NGO UnityTransport. (#2496) - Fixed some errors that could occur if a connection is lost and the loss is detected when attempting to write to the socket. (#2495) ## Changed - Adding network prefabs before NetworkManager initialization is now supported. (#2565) - Connecting clients being synchronized now switch to the server's active scene before spawning and synchronizing NetworkObjects. (#2532) - Updated `UnityTransport` dependency on `com.unity.transport` to 1.3.4. (#2533) - Improved performance of NetworkBehaviour initialization by replacing reflection when initializing NetworkVariables with compile-time code generation, which should help reduce hitching during additive scene loads. (#2522)
2023-06-07 00:00:00 +00:00
parent b5abc3ff7c
commit 4d70c198bd
119 changed files with 11328 additions and 3164 deletions
--- a/Tests/Editor/Serialization/FastBufferWriterTests.cs
+++ b/Tests/Editor/Serialization/FastBufferWriterTests.cs
@@ -2,6 +2,7 @@ using System;
 using System.Reflection;
 using NUnit.Framework;
 using Unity.Collections;
+using Unity.Collections.LowLevel.Unsafe;
 using UnityEngine;
 using Random = System.Random;

@@ -80,6 +81,11 @@ namespace Unity.Netcode.EditorTests
                        {
                            continue;
                        }
+
+                        if (candidateMethod.GetParameters()[0].ParameterType.IsGenericType)
+                        {
+                            continue;
+                        }
                        try
                        {
                            method = candidateMethod.MakeGenericMethod(typeof(T));
@@ -121,6 +127,10 @@ namespace Unity.Netcode.EditorTests
                        {
                            continue;
                        }
+                        if (candidateMethod.GetParameters()[0].ParameterType.IsGenericType)
+                        {
+                            continue;
+                        }
                        try
                        {
                            method = candidateMethod.MakeGenericMethod(typeof(T));
@@ -145,6 +155,90 @@ namespace Unity.Netcode.EditorTests
            method.Invoke(writer, args);
        }

+        private void RunMethod<T>(string methodName, FastBufferWriter writer, in NativeArray<T> value) where T : unmanaged
+        {
+            MethodInfo method = typeof(FastBufferWriter).GetMethod(methodName, new[] { typeof(NativeArray<T>) });
+            if (method == null)
+            {
+                foreach (var candidateMethod in typeof(FastBufferWriter).GetMethods())
+                {
+                    if (candidateMethod.Name == methodName && candidateMethod.IsGenericMethodDefinition)
+                    {
+                        if (candidateMethod.GetParameters().Length == 0 || (candidateMethod.GetParameters().Length > 1 && !candidateMethod.GetParameters()[1].HasDefaultValue))
+                        {
+                            continue;
+                        }
+                        if (!candidateMethod.GetParameters()[0].ParameterType.Name.Contains("NativeArray"))
+                        {
+                            continue;
+                        }
+                        try
+                        {
+                            method = candidateMethod.MakeGenericMethod(typeof(T));
+                            break;
+                        }
+                        catch (ArgumentException)
+                        {
+                            continue;
+                        }
+                    }
+                }
+            }
+
+            Assert.NotNull(method);
+
+            object[] args = new object[method.GetParameters().Length];
+            args[0] = value;
+            for (var i = 1; i < args.Length; ++i)
+            {
+                args[i] = method.GetParameters()[i].DefaultValue;
+            }
+            method.Invoke(writer, args);
+        }
+
+#if UNITY_NETCODE_NATIVE_COLLECTION_SUPPORT
+        private void RunMethod<T>(string methodName, FastBufferWriter writer, in NativeList<T> value) where T : unmanaged
+        {
+            MethodInfo method = typeof(FastBufferWriter).GetMethod(methodName, new[] { typeof(NativeList<T>) });
+            if (method == null)
+            {
+                foreach (var candidateMethod in typeof(FastBufferWriter).GetMethods())
+                {
+                    if (candidateMethod.Name == methodName && candidateMethod.IsGenericMethodDefinition)
+                    {
+                        if (candidateMethod.GetParameters().Length == 0 || (candidateMethod.GetParameters().Length > 1 && !candidateMethod.GetParameters()[1].HasDefaultValue))
+                        {
+                            continue;
+                        }
+                        if (!candidateMethod.GetParameters()[0].ParameterType.Name.Contains("NativeList"))
+                        {
+                            continue;
+                        }
+                        try
+                        {
+                            method = candidateMethod.MakeGenericMethod(typeof(T));
+                            break;
+                        }
+                        catch (ArgumentException)
+                        {
+                            continue;
+                        }
+                    }
+                }
+            }
+
+            Assert.NotNull(method);
+
+            object[] args = new object[method.GetParameters().Length];
+            args[0] = value;
+            for (var i = 1; i < args.Length; ++i)
+            {
+                args[i] = method.GetParameters()[i].DefaultValue;
+            }
+            method.Invoke(writer, args);
+        }
+#endif
+

        protected override unsafe void RunTypeTest<T>(T valueToTest)
        {
@@ -199,6 +293,34 @@ namespace Unity.Netcode.EditorTests
            }
        }

+        private unsafe void VerifyArrayEquality<T>(NativeArray<T> value, byte* unsafePtr, int offset) where T : unmanaged
+        {
+            int* sizeValue = (int*)(unsafePtr + offset);
+            Assert.AreEqual(value.Length, *sizeValue);
+
+            var asTPointer = (T*)value.GetUnsafePtr();
+            var underlyingTArray = (T*)(unsafePtr + sizeof(int) + offset);
+            for (var i = 0; i < value.Length; ++i)
+            {
+                Assert.AreEqual(asTPointer[i], underlyingTArray[i]);
+            }
+        }
+
+#if UNITY_NETCODE_NATIVE_COLLECTION_SUPPORT
+        private unsafe void VerifyArrayEquality<T>(NativeList<T> value, byte* unsafePtr, int offset) where T : unmanaged
+        {
+            int* sizeValue = (int*)(unsafePtr + offset);
+            Assert.AreEqual(value.Length, *sizeValue);
+
+            var asTPointer = (T*)value.GetUnsafePtr();
+            var underlyingTArray = (T*)(unsafePtr + sizeof(int) + offset);
+            for (var i = 0; i < value.Length; ++i)
+            {
+                Assert.AreEqual(asTPointer[i], underlyingTArray[i]);
+            }
+        }
+#endif
+
        protected override unsafe void RunTypeArrayTest<T>(T[] valueToTest)
        {
            var writeSize = FastBufferWriter.GetWriteSize(valueToTest);
@@ -242,6 +364,96 @@ namespace Unity.Netcode.EditorTests
            }
        }

+
+        protected override unsafe void RunTypeNativeArrayTest<T>(NativeArray<T> valueToTest)
+        {
+            var writeSize = FastBufferWriter.GetWriteSize(valueToTest);
+            var writer = new FastBufferWriter(writeSize + 2, Allocator.Temp);
+            using (writer)
+            {
+
+                Assert.AreEqual(sizeof(int) + sizeof(T) * valueToTest.Length, writeSize);
+                Assert.IsTrue(writer.TryBeginWrite(writeSize + 2), "Writer denied write permission");
+
+                RunMethod(nameof(FastBufferWriter.WriteValue), writer, valueToTest);
+                VerifyPositionAndLength(writer, writeSize);
+
+                WriteCheckBytes(writer, writeSize);
+
+                VerifyArrayEquality(valueToTest, writer.GetUnsafePtr(), 0);
+
+                var underlyingArray = writer.ToArray();
+                VerifyCheckBytes(underlyingArray, writeSize);
+            }
+        }
+
+        protected override unsafe void RunTypeNativeArrayTestSafe<T>(NativeArray<T> valueToTest)
+        {
+            var writeSize = FastBufferWriter.GetWriteSize(valueToTest);
+            var writer = new FastBufferWriter(writeSize + 2, Allocator.Temp);
+            using (writer)
+            {
+
+                Assert.AreEqual(sizeof(int) + sizeof(T) * valueToTest.Length, writeSize);
+
+                RunMethod(nameof(FastBufferWriter.WriteValueSafe), writer, valueToTest);
+                VerifyPositionAndLength(writer, writeSize);
+
+                WriteCheckBytes(writer, writeSize);
+
+                VerifyArrayEquality(valueToTest, writer.GetUnsafePtr(), 0);
+
+                var underlyingArray = writer.ToArray();
+                VerifyCheckBytes(underlyingArray, writeSize);
+            }
+        }
+
+
+#if UNITY_NETCODE_NATIVE_COLLECTION_SUPPORT
+        protected override unsafe void RunTypeNativeListTest<T>(NativeList<T> valueToTest)
+        {
+            var writeSize = FastBufferWriter.GetWriteSize(valueToTest);
+            var writer = new FastBufferWriter(writeSize + 2, Allocator.Temp);
+            using (writer)
+            {
+
+                Assert.AreEqual(sizeof(int) + sizeof(T) * valueToTest.Length, writeSize);
+                Assert.IsTrue(writer.TryBeginWrite(writeSize + 2), "Writer denied write permission");
+
+                RunMethod(nameof(FastBufferWriter.WriteValue), writer, valueToTest);
+                VerifyPositionAndLength(writer, writeSize);
+
+                WriteCheckBytes(writer, writeSize);
+
+                VerifyArrayEquality(valueToTest, writer.GetUnsafePtr(), 0);
+
+                var underlyingArray = writer.ToArray();
+                VerifyCheckBytes(underlyingArray, writeSize);
+            }
+        }
+
+        protected override unsafe void RunTypeNativeListTestSafe<T>(NativeList<T> valueToTest)
+        {
+            var writeSize = FastBufferWriter.GetWriteSize(valueToTest);
+            var writer = new FastBufferWriter(writeSize + 2, Allocator.Temp);
+            using (writer)
+            {
+
+                Assert.AreEqual(sizeof(int) + sizeof(T) * valueToTest.Length, writeSize);
+
+                RunMethod(nameof(FastBufferWriter.WriteValueSafe), writer, valueToTest);
+                VerifyPositionAndLength(writer, writeSize);
+
+                WriteCheckBytes(writer, writeSize);
+
+                VerifyArrayEquality(valueToTest, writer.GetUnsafePtr(), 0);
+
+                var underlyingArray = writer.ToArray();
+                VerifyCheckBytes(underlyingArray, writeSize);
+            }
+        }
+#endif
+
        [Test, Description("Tests")]
        public void WhenWritingUnmanagedType_ValueIsWrittenCorrectly(
            [Values(typeof(byte), typeof(sbyte), typeof(short), typeof(ushort), typeof(int), typeof(uint),
@@ -270,6 +482,36 @@ namespace Unity.Netcode.EditorTests
            BaseArrayTypeTest(testType, writeType);
        }

+        [Test]
+        public void WhenWritingNativeArrayOfUnmanagedElementType_NativeArrayIsWrittenCorrectly(
+            [Values(typeof(byte), typeof(sbyte), typeof(short), typeof(ushort), typeof(int), typeof(uint),
+                typeof(long), typeof(ulong), typeof(bool), typeof(char), typeof(float), typeof(double),
+                typeof(ByteEnum), typeof(SByteEnum), typeof(ShortEnum), typeof(UShortEnum), typeof(IntEnum),
+                typeof(UIntEnum), typeof(LongEnum), typeof(ULongEnum), typeof(Vector2), typeof(Vector3),
+                typeof(Vector2Int), typeof(Vector3Int), typeof(Vector4), typeof(Quaternion), typeof(Color),
+                typeof(Color32), typeof(Ray), typeof(Ray2D), typeof(TestStruct))]
+            Type testType,
+            [Values] WriteType writeType)
+        {
+            BaseNativeArrayTypeTest(testType, writeType);
+        }
+
+#if UNITY_NETCODE_NATIVE_COLLECTION_SUPPORT
+        [Test]
+        public void WhenWritingNativeListOfUnmanagedElementType_NativeListIsWrittenCorrectly(
+            [Values(typeof(byte), typeof(sbyte), typeof(short), typeof(ushort), typeof(int), typeof(uint),
+                typeof(long), typeof(ulong), typeof(bool), typeof(char), typeof(float), typeof(double),
+                typeof(ByteEnum), typeof(SByteEnum), typeof(ShortEnum), typeof(UShortEnum), typeof(IntEnum),
+                typeof(UIntEnum), typeof(LongEnum), typeof(ULongEnum), typeof(Vector2), typeof(Vector3),
+                typeof(Vector2Int), typeof(Vector3Int), typeof(Vector4), typeof(Quaternion), typeof(Color),
+                typeof(Color32), typeof(Ray), typeof(Ray2D), typeof(TestStruct))]
+            Type testType,
+            [Values] WriteType writeType)
+        {
+            BaseNativeListTypeTest(testType, writeType);
+        }
+#endif
+
        [TestCase(false, WriteType.WriteDirect)]
        [TestCase(false, WriteType.WriteSafe)]
        [TestCase(true, WriteType.WriteDirect)]