com.unity.netcode.gameobjects@1.9.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.9.1] - 2024-04-18

### Added
- Added AnticipatedNetworkVariable<T>, which adds support for client anticipation of NetworkVariable values, allowing for more responsive gameplay (#2820)
- Added AnticipatedNetworkTransform, which adds support for client anticipation of NetworkTransforms (#2820)
- Added NetworkVariableBase.ExceedsDirtinessThreshold to allow network variables to throttle updates by only sending updates when the difference between the current and previous values exceeds a threshold. (This is exposed in NetworkVariable<T> with the callback NetworkVariable<T>.CheckExceedsDirtinessThreshold) (#2820)
- Added NetworkVariableUpdateTraits, which add additional throttling support: MinSecondsBetweenUpdates will prevent the NetworkVariable from sending updates more often than the specified time period (even if it exceeds the dirtiness threshold), while MaxSecondsBetweenUpdates will force a dirty NetworkVariable to send an update after the specified time period even if it has not yet exceeded the dirtiness threshold. (#2820)
- Added virtual method NetworkVariableBase.OnInitialize() which can be used by NetworkVariable subclasses to add initialization code (#2820)
- Added virtual method NetworkVariableBase.Update(), which is called once per frame to support behaviors such as interpolation between an anticipated value and an authoritative one. (#2820)
- Added NetworkTime.TickWithPartial, which represents the current tick as a double that includes the fractional/partial tick value. (#2820)
- Added NetworkTickSystem.AnticipationTick, which can be helpful with implementation of client anticipation. This value represents the tick the current local client was at at the beginning of the most recent network round trip, which enables it to correlate server update ticks with the client tick that may have triggered them. (#2820)
- `NetworkVariable` now includes built-in support for `NativeHashSet`, `NativeHashMap`, `List`, `HashSet`, and `Dictionary` (#2813)
- `NetworkVariable` now includes delta compression for collection values (`NativeList`, `NativeArray`, `NativeHashSet`, `NativeHashMap`, `List`, `HashSet`, `Dictionary`, and `FixedString` types) to save bandwidth by only sending the values that changed. (Note: For `NativeList`, `NativeArray`, and `List`, this algorithm works differently than that used in `NetworkList`. This algorithm will use less bandwidth for "set" and "add" operations, but `NetworkList` is more bandwidth-efficient if you are performing frequent "insert" operations.) (#2813)
- `UserNetworkVariableSerialization` now has optional callbacks for `WriteDelta` and `ReadDelta`. If both are provided, they will be used for all serialization operations on NetworkVariables of that type except for the first one for each client. If either is missing, the existing `Write` and `Read` will always be used. (#2813)
- Network variables wrapping `INetworkSerializable` types can perform delta serialization by setting `UserNetworkVariableSerialization<T>.WriteDelta` and `UserNetworkVariableSerialization<T>.ReadDelta` for those types. The built-in `INetworkSerializable` serializer will continue to be used for all other serialization operations, but if those callbacks are set, it will call into them on all but the initial serialization to perform delta serialization. (This could be useful if you have a large struct where most values do not change regularly and you want to send only the fields that did change.) (#2813)

### Fixed

- Fixed issue where NetworkTransformEditor would throw and exception if you excluded the physics package. (#2871)
- Fixed issue where `NetworkTransform` could not properly synchronize its base position when using half float precision. (#2845)
- Fixed issue where the host was not invoking `OnClientDisconnectCallback` for its own local client when internally shutting down. (#2822)
- Fixed issue where NetworkTransform could potentially attempt to "unregister" a named message prior to it being registered. (#2807)
- Fixed issue where in-scene placed `NetworkObject`s with complex nested children `NetworkObject`s (more than one child in depth) would not synchronize properly if WorldPositionStays was set to true. (#2796)

### Changed

- Changed `NetworkObjectReference` and `NetworkBehaviourReference` to allow null references when constructing and serializing. (#2874)
- Changed `NetworkAnimator` no longer requires the `Animator` component to exist on the same `GameObject`. (#2872)
- Changed `NetworkTransform` to now use `NetworkTransformMessage` as opposed to named messages for NetworkTransformState updates. (#2810)
- Changed `CustomMessageManager` so it no longer attempts to register or "unregister" a null or empty string and will log an error if this condition occurs. (#2807)
This commit is contained in:
Unity Technologies
2024-04-18 00:00:00 +00:00
parent f8ebf679ec
commit 158f26b913
72 changed files with 9955 additions and 1289 deletions

View File

@@ -1,4 +1,6 @@
#if !MULTIPLAYER_TOOLS && !NGO_MINIMALPROJECT
using System;
using System.Collections;
using System.Collections.Generic;
using System.Diagnostics;
using System.Linq;
@@ -7,6 +9,7 @@ using NUnit.Framework;
using Unity.Collections;
using Unity.Netcode.TestHelpers.Runtime;
using UnityEngine;
using UnityEngine.TestTools;
using Object = UnityEngine.Object;
using Random = System.Random;
@@ -24,6 +27,7 @@ namespace Unity.Netcode.RuntimeTests.UniversalRpcTests
public string Received = string.Empty;
public Tuple<int, bool, float, string> ReceivedParams = null;
public ulong ReceivedFrom = ulong.MaxValue;
public int ReceivedCount;
public void OnRpcReceived()
{
@@ -32,6 +36,7 @@ namespace Unity.Netcode.RuntimeTests.UniversalRpcTests
var currentMethod = sf.GetMethod();
Received = currentMethod.Name;
ReceivedCount++;
}
public void OnRpcReceivedWithParams(int a, bool b, float f, string s)
{
@@ -40,6 +45,7 @@ namespace Unity.Netcode.RuntimeTests.UniversalRpcTests
var currentMethod = sf.GetMethod();
Received = currentMethod.Name;
ReceivedCount++;
ReceivedParams = new Tuple<int, bool, float, string>(a, b, f, s);
}
@@ -448,6 +454,9 @@ namespace Unity.Netcode.RuntimeTests.UniversalRpcTests
public class UniversalRpcTestsBase : NetcodeIntegrationTest
{
public static int YieldCheck = 0;
public const int YieldCycleCount = 10;
protected override int NumberOfClients => 2;
public UniversalRpcTestsBase(HostOrServer hostOrServer) : base(hostOrServer)
@@ -488,6 +497,7 @@ namespace Unity.Netcode.RuntimeTests.UniversalRpcTests
protected override void OnInlineTearDown()
{
MockTransport.ClearQueues();
Clear();
}
@@ -496,6 +506,7 @@ namespace Unity.Netcode.RuntimeTests.UniversalRpcTests
foreach (var obj in Object.FindObjectsByType<UniversalRpcNetworkBehaviour>(FindObjectsSortMode.None))
{
obj.Received = string.Empty;
obj.ReceivedCount = 0;
obj.ReceivedParams = null;
obj.ReceivedFrom = ulong.MaxValue;
}
@@ -528,10 +539,11 @@ namespace Unity.Netcode.RuntimeTests.UniversalRpcTests
return m_PlayerNetworkObjects[onClient][ownerClientId].GetComponent<UniversalRpcNetworkBehaviour>();
}
protected void VerifyLocalReceived(ulong objectOwner, ulong sender, string name, bool verifyReceivedFrom)
protected void VerifyLocalReceived(ulong objectOwner, ulong sender, string name, bool verifyReceivedFrom, int expectedReceived = 1)
{
var obj = GetPlayerObject(objectOwner, sender);
Assert.AreEqual(name, obj.Received);
Assert.That(obj.ReceivedCount, Is.EqualTo(expectedReceived));
Assert.IsNull(obj.ReceivedParams);
if (verifyReceivedFrom)
{
@@ -543,6 +555,7 @@ namespace Unity.Netcode.RuntimeTests.UniversalRpcTests
{
var obj = GetPlayerObject(objectOwner, sender);
Assert.AreEqual(name, obj.Received);
Assert.That(obj.ReceivedCount, Is.EqualTo(1));
Assert.IsNotNull(obj.ReceivedParams);
Assert.AreEqual(i, obj.ReceivedParams.Item1);
Assert.AreEqual(b, obj.ReceivedParams.Item2);
@@ -556,17 +569,18 @@ namespace Unity.Netcode.RuntimeTests.UniversalRpcTests
{
UniversalRpcNetworkBehaviour playerObject = GetPlayerObject(objectOwner, client);
Assert.AreEqual(string.Empty, playerObject.Received);
Assert.That(playerObject.ReceivedCount, Is.EqualTo(0));
Assert.IsNull(playerObject.ReceivedParams);
}
}
protected void VerifyRemoteReceived(ulong objectOwner, ulong sender, string message, ulong[] receivedBy, bool verifyReceivedFrom, bool waitForMessages = true)
protected void VerifyRemoteReceived(ulong objectOwner, ulong sender, string message, ulong[] receivedBy, bool verifyReceivedFrom, bool waitForMessages = true, int expectedReceived = 1)
{
foreach (var client in receivedBy)
{
if (client == sender)
{
VerifyLocalReceived(objectOwner, sender, message, verifyReceivedFrom);
VerifyLocalReceived(objectOwner, sender, message, verifyReceivedFrom, expectedReceived);
break;
}
@@ -628,6 +642,7 @@ namespace Unity.Netcode.RuntimeTests.UniversalRpcTests
{
UniversalRpcNetworkBehaviour playerObject = GetPlayerObject(objectOwner, client);
Assert.AreEqual(message, playerObject.Received);
Assert.That(playerObject.ReceivedCount, Is.EqualTo(expectedReceived));
Assert.IsNull(playerObject.ReceivedParams);
if (verifyReceivedFrom)
{
@@ -701,6 +716,7 @@ namespace Unity.Netcode.RuntimeTests.UniversalRpcTests
{
UniversalRpcNetworkBehaviour playerObject = GetPlayerObject(objectOwner, client);
Assert.AreEqual(message, playerObject.Received);
Assert.That(playerObject.ReceivedCount, Is.EqualTo(1));
Assert.IsNotNull(playerObject.ReceivedParams);
Assert.AreEqual(i, playerObject.ReceivedParams.Item1);
@@ -1159,27 +1175,40 @@ namespace Unity.Netcode.RuntimeTests.UniversalRpcTests
}
[Test]
public void TestSendingWithSingleOverride(
[Values] SendTo defaultSendTo,
[Values(0u, 1u, 2u)] ulong recipient,
[Values(0u, 1u, 2u)] ulong objectOwner,
[Values(0u, 1u, 2u)] ulong sender
)
[UnityTest]
public IEnumerator TestSendingWithSingleOverride()
{
var sendMethodName = $"DefaultTo{defaultSendTo}AllowOverrideRpc";
foreach (var defaultSendTo in Enum.GetValues(typeof(SendTo)))
{
for (ulong recipient = 0u; recipient <= 2u; ++recipient)
{
for (ulong objectOwner = 0u; objectOwner <= 2u; ++objectOwner)
{
for (ulong sender = 0u; sender <= 2u; ++sender)
{
if (++YieldCheck % YieldCycleCount == 0)
{
yield return null;
}
OnInlineSetup();
var sendMethodName = $"DefaultTo{defaultSendTo}AllowOverrideRpc";
var senderObject = GetPlayerObject(objectOwner, sender);
var target = senderObject.RpcTarget.Single(recipient, RpcTargetUse.Temp);
var sendMethod = senderObject.GetType().GetMethod(sendMethodName);
sendMethod.Invoke(senderObject, new object[] { (RpcParams)target });
var senderObject = GetPlayerObject(objectOwner, sender);
var target = senderObject.RpcTarget.Single(recipient, RpcTargetUse.Temp);
var sendMethod = senderObject.GetType().GetMethod(sendMethodName);
sendMethod.Invoke(senderObject, new object[] { (RpcParams)target });
VerifyRemoteReceived(objectOwner, sender, sendMethodName, new[] { recipient }, false);
VerifyNotReceived(objectOwner, s_ClientIds.Where(c => recipient != c).ToArray());
VerifyRemoteReceived(objectOwner, sender, sendMethodName, new[] { recipient }, false);
VerifyNotReceived(objectOwner, s_ClientIds.Where(c => recipient != c).ToArray());
// Pass some time to make sure that no other client ever receives this
TimeTravel(1f, 30);
VerifyNotReceived(objectOwner, s_ClientIds.Where(c => recipient != c).ToArray());
// Pass some time to make sure that no other client ever receives this
TimeTravel(1f, 30);
VerifyNotReceived(objectOwner, s_ClientIds.Where(c => recipient != c).ToArray());
OnInlineTearDown();
}
}
}
}
}
}
@@ -1193,27 +1222,40 @@ namespace Unity.Netcode.RuntimeTests.UniversalRpcTests
}
[Test]
public void TestSendingWithSingleNotOverride(
[Values] SendTo defaultSendTo,
[Values(0u, 1u, 2u)] ulong recipient,
[Values(0u, 1u, 2u)] ulong objectOwner,
[Values(0u, 1u, 2u)] ulong sender
)
[UnityTest]
public IEnumerator TestSendingWithSingleNotOverride()
{
var sendMethodName = $"DefaultTo{defaultSendTo}AllowOverrideRpc";
foreach (var defaultSendTo in Enum.GetValues(typeof(SendTo)))
{
for (ulong recipient = 0u; recipient <= 2u; ++recipient)
{
for (ulong objectOwner = 0u; objectOwner <= 2u; ++objectOwner)
{
for (ulong sender = 0u; sender <= 2u; ++sender)
{
if (++YieldCheck % YieldCycleCount == 0)
{
yield return null;
}
OnInlineSetup();
var sendMethodName = $"DefaultTo{defaultSendTo}AllowOverrideRpc";
var senderObject = GetPlayerObject(objectOwner, sender);
var target = senderObject.RpcTarget.Not(recipient, RpcTargetUse.Temp);
var sendMethod = senderObject.GetType().GetMethod(sendMethodName);
sendMethod.Invoke(senderObject, new object[] { (RpcParams)target });
var senderObject = GetPlayerObject(objectOwner, sender);
var target = senderObject.RpcTarget.Not(recipient, RpcTargetUse.Temp);
var sendMethod = senderObject.GetType().GetMethod(sendMethodName);
sendMethod.Invoke(senderObject, new object[] { (RpcParams)target });
VerifyRemoteReceived(objectOwner, sender, sendMethodName, s_ClientIds.Where(c => recipient != c).ToArray(), false);
VerifyNotReceived(objectOwner, new[] { recipient });
VerifyRemoteReceived(objectOwner, sender, sendMethodName, s_ClientIds.Where(c => recipient != c).ToArray(), false);
VerifyNotReceived(objectOwner, new[] { recipient });
// Pass some time to make sure that no other client ever receives this
TimeTravel(1f, 30);
VerifyNotReceived(objectOwner, new[] { recipient });
// Pass some time to make sure that no other client ever receives this
TimeTravel(1f, 30);
VerifyNotReceived(objectOwner, new[] { recipient });
OnInlineTearDown();
}
}
}
}
}
}
@@ -1243,56 +1285,80 @@ namespace Unity.Netcode.RuntimeTests.UniversalRpcTests
List
}
[Test]
public void TestSendingWithGroupOverride(
[Values] SendTo defaultSendTo,
[ValueSource(nameof(RecipientGroups))] ulong[] recipient,
[Values(0u, 1u, 2u)] ulong objectOwner,
[Values(0u, 1u, 2u)] ulong sender,
[Values] AllocationType allocationType
)
// Extending timeout since the added yield return causes this test to commonly timeout
[Timeout(600000)]
[UnityTest]
public IEnumerator TestSendingWithGroupOverride()
{
var sendMethodName = $"DefaultTo{defaultSendTo}AllowOverrideRpc";
var senderObject = GetPlayerObject(objectOwner, sender);
BaseRpcTarget target = null;
switch (allocationType)
var waitFor = new WaitForFixedUpdate();
foreach (var defaultSendTo in Enum.GetValues(typeof(SendTo)))
{
case AllocationType.Array:
target = senderObject.RpcTarget.Group(recipient, RpcTargetUse.Temp);
break;
case AllocationType.List:
target = senderObject.RpcTarget.Group(recipient.ToList(), RpcTargetUse.Temp);
break;
case AllocationType.NativeArray:
var arr = new NativeArray<ulong>(recipient, Allocator.Temp);
target = senderObject.RpcTarget.Group(arr, RpcTargetUse.Temp);
arr.Dispose();
break;
case AllocationType.NativeList:
// For some reason on 2020.3, calling list.AsArray() and passing that to the next function
// causes Allocator.Temp allocations to become invalid somehow. This is not an issue on later
// versions of Unity.
var list = new NativeList<ulong>(recipient.Length, Allocator.TempJob);
foreach (var id in recipient)
m_EnableVerboseDebug = true;
VerboseDebug($"Processing: {defaultSendTo}");
m_EnableVerboseDebug = false;
foreach (var recipient in RecipientGroups)
{
for (ulong objectOwner = 0u; objectOwner <= 2u; ++objectOwner)
{
list.Add(id);
for (ulong sender = 0u; sender <= 2u; ++sender)
{
yield return waitFor;
foreach (var allocationType in Enum.GetValues(typeof(AllocationType)))
{
//if (++YieldCheck % YieldCycleCount == 0)
//{
// yield return null;
//}
OnInlineSetup();
var sendMethodName = $"DefaultTo{defaultSendTo}AllowOverrideRpc";
var senderObject = GetPlayerObject(objectOwner, sender);
BaseRpcTarget target = null;
switch (allocationType)
{
case AllocationType.Array:
target = senderObject.RpcTarget.Group(recipient, RpcTargetUse.Temp);
break;
case AllocationType.List:
target = senderObject.RpcTarget.Group(recipient.ToList(), RpcTargetUse.Temp);
break;
case AllocationType.NativeArray:
var arr = new NativeArray<ulong>(recipient, Allocator.Temp);
target = senderObject.RpcTarget.Group(arr, RpcTargetUse.Temp);
arr.Dispose();
break;
case AllocationType.NativeList:
// For some reason on 2020.3, calling list.AsArray() and passing that to the next function
// causes Allocator.Temp allocations to become invalid somehow. This is not an issue on later
// versions of Unity.
var list = new NativeList<ulong>(recipient.Length, Allocator.TempJob);
foreach (var id in recipient)
{
list.Add(id);
}
target = senderObject.RpcTarget.Group(list, RpcTargetUse.Temp);
list.Dispose();
break;
}
var sendMethod = senderObject.GetType().GetMethod(sendMethodName);
sendMethod.Invoke(senderObject, new object[] { (RpcParams)target });
VerifyRemoteReceived(objectOwner, sender, sendMethodName, s_ClientIds.Where(c => recipient.Contains(c)).ToArray(), false);
VerifyNotReceived(objectOwner, s_ClientIds.Where(c => !recipient.Contains(c)).ToArray());
// Pass some time to make sure that no other client ever receives this
TimeTravel(1f, 30);
VerifyNotReceived(objectOwner, s_ClientIds.Where(c => !recipient.Contains(c)).ToArray());
OnInlineTearDown();
}
}
}
target = senderObject.RpcTarget.Group(list, RpcTargetUse.Temp);
list.Dispose();
break;
}
}
var sendMethod = senderObject.GetType().GetMethod(sendMethodName);
sendMethod.Invoke(senderObject, new object[] { (RpcParams)target });
VerifyRemoteReceived(objectOwner, sender, sendMethodName, s_ClientIds.Where(c => recipient.Contains(c)).ToArray(), false);
VerifyNotReceived(objectOwner, s_ClientIds.Where(c => !recipient.Contains(c)).ToArray());
// Pass some time to make sure that no other client ever receives this
TimeTravel(1f, 30);
VerifyNotReceived(objectOwner, s_ClientIds.Where(c => !recipient.Contains(c)).ToArray());
}
}
[TestFixture(HostOrServer.Host)]
@@ -1320,54 +1386,78 @@ namespace Unity.Netcode.RuntimeTests.UniversalRpcTests
List
}
[Test]
public void TestSendingWithGroupNotOverride(
[Values] SendTo defaultSendTo,
[ValueSource(nameof(RecipientGroups))] ulong[] recipient,
[Values(0u, 1u, 2u)] ulong objectOwner,
[Values(0u, 1u, 2u)] ulong sender,
[Values] AllocationType allocationType
)
// Extending timeout since the added yield return causes this test to commonly timeout
[Timeout(600000)]
[UnityTest]
public IEnumerator TestSendingWithGroupNotOverride()
{
var sendMethodName = $"DefaultTo{defaultSendTo}AllowOverrideRpc";
var senderObject = GetPlayerObject(objectOwner, sender);
BaseRpcTarget target = null;
switch (allocationType)
var waitFor = new WaitForFixedUpdate();
foreach (var defaultSendTo in Enum.GetValues(typeof(SendTo)))
{
case AllocationType.Array:
target = senderObject.RpcTarget.Not(recipient, RpcTargetUse.Temp);
break;
case AllocationType.List:
target = senderObject.RpcTarget.Not(recipient.ToList(), RpcTargetUse.Temp);
break;
case AllocationType.NativeArray:
var arr = new NativeArray<ulong>(recipient, Allocator.Temp);
target = senderObject.RpcTarget.Not(arr, RpcTargetUse.Temp);
arr.Dispose();
break;
case AllocationType.NativeList:
// For some reason on 2020.3, calling list.AsArray() and passing that to the next function
// causes Allocator.Temp allocations to become invalid somehow. This is not an issue on later
// versions of Unity.
var list = new NativeList<ulong>(recipient.Length, Allocator.TempJob);
foreach (var id in recipient)
m_EnableVerboseDebug = true;
VerboseDebug($"Processing: {defaultSendTo}");
m_EnableVerboseDebug = false;
foreach (var recipient in RecipientGroups)
{
for (ulong objectOwner = 0u; objectOwner <= 2u; ++objectOwner)
{
list.Add(id);
for (ulong sender = 0u; sender <= 2u; ++sender)
{
yield return waitFor;
foreach (var allocationType in Enum.GetValues(typeof(AllocationType)))
{
//if (++YieldCheck % YieldCycleCount == 0)
//{
// yield return waitFor;
//}
OnInlineSetup();
var sendMethodName = $"DefaultTo{defaultSendTo}AllowOverrideRpc";
var senderObject = GetPlayerObject(objectOwner, sender);
BaseRpcTarget target = null;
switch (allocationType)
{
case AllocationType.Array:
target = senderObject.RpcTarget.Not(recipient, RpcTargetUse.Temp);
break;
case AllocationType.List:
target = senderObject.RpcTarget.Not(recipient.ToList(), RpcTargetUse.Temp);
break;
case AllocationType.NativeArray:
var arr = new NativeArray<ulong>(recipient, Allocator.Temp);
target = senderObject.RpcTarget.Not(arr, RpcTargetUse.Temp);
arr.Dispose();
break;
case AllocationType.NativeList:
// For some reason on 2020.3, calling list.AsArray() and passing that to the next function
// causes Allocator.Temp allocations to become invalid somehow. This is not an issue on later
// versions of Unity.
var list = new NativeList<ulong>(recipient.Length, Allocator.TempJob);
foreach (var id in recipient)
{
list.Add(id);
}
target = senderObject.RpcTarget.Not(list, RpcTargetUse.Temp);
list.Dispose();
break;
}
var sendMethod = senderObject.GetType().GetMethod(sendMethodName);
sendMethod.Invoke(senderObject, new object[] { (RpcParams)target });
VerifyRemoteReceived(objectOwner, sender, sendMethodName, s_ClientIds.Where(c => !recipient.Contains(c)).ToArray(), false);
VerifyNotReceived(objectOwner, s_ClientIds.Where(c => recipient.Contains(c)).ToArray());
// Pass some time to make sure that no other client ever receives this
TimeTravel(1f, 30);
VerifyNotReceived(objectOwner, s_ClientIds.Where(c => recipient.Contains(c)).ToArray());
OnInlineTearDown();
}
}
}
target = senderObject.RpcTarget.Not(list, RpcTargetUse.Temp);
list.Dispose();
break;
}
}
var sendMethod = senderObject.GetType().GetMethod(sendMethodName);
sendMethod.Invoke(senderObject, new object[] { (RpcParams)target });
VerifyRemoteReceived(objectOwner, sender, sendMethodName, s_ClientIds.Where(c => !recipient.Contains(c)).ToArray(), false);
VerifyNotReceived(objectOwner, s_ClientIds.Where(c => recipient.Contains(c)).ToArray());
// Pass some time to make sure that no other client ever receives this
TimeTravel(1f, 30);
VerifyNotReceived(objectOwner, s_ClientIds.Where(c => recipient.Contains(c)).ToArray());
}
}
@@ -1391,223 +1481,180 @@ namespace Unity.Netcode.RuntimeTests.UniversalRpcTests
}
[Test]
// All the test cases that involve sends that will be delivered locally
[TestCase(SendTo.Everyone, 0u, 0u)]
[TestCase(SendTo.Everyone, 0u, 1u)]
[TestCase(SendTo.Everyone, 0u, 2u)]
[TestCase(SendTo.Everyone, 1u, 0u)]
[TestCase(SendTo.Everyone, 1u, 1u)]
[TestCase(SendTo.Everyone, 1u, 2u)]
[TestCase(SendTo.Everyone, 2u, 0u)]
[TestCase(SendTo.Everyone, 2u, 1u)]
[TestCase(SendTo.Everyone, 2u, 2u)]
[TestCase(SendTo.Me, 0u, 0u)]
[TestCase(SendTo.Me, 0u, 1u)]
[TestCase(SendTo.Me, 0u, 2u)]
[TestCase(SendTo.Me, 1u, 0u)]
[TestCase(SendTo.Me, 1u, 1u)]
[TestCase(SendTo.Me, 1u, 2u)]
[TestCase(SendTo.Me, 2u, 0u)]
[TestCase(SendTo.Me, 2u, 1u)]
[TestCase(SendTo.Me, 2u, 2u)]
[TestCase(SendTo.Owner, 0u, 0u)]
[TestCase(SendTo.Owner, 1u, 1u)]
[TestCase(SendTo.Owner, 2u, 2u)]
[TestCase(SendTo.Server, 0u, 0u)]
[TestCase(SendTo.Server, 1u, 0u)]
[TestCase(SendTo.Server, 2u, 0u)]
[TestCase(SendTo.NotOwner, 0u, 1u)]
[TestCase(SendTo.NotOwner, 0u, 2u)]
[TestCase(SendTo.NotOwner, 1u, 0u)]
[TestCase(SendTo.NotOwner, 1u, 2u)]
[TestCase(SendTo.NotOwner, 2u, 0u)]
[TestCase(SendTo.NotOwner, 2u, 1u)]
[TestCase(SendTo.NotServer, 0u, 1u)]
[TestCase(SendTo.NotServer, 0u, 2u)]
[TestCase(SendTo.NotServer, 1u, 1u)]
[TestCase(SendTo.NotServer, 1u, 2u)]
[TestCase(SendTo.NotServer, 2u, 1u)]
[TestCase(SendTo.NotServer, 2u, 2u)]
[TestCase(SendTo.ClientsAndHost, 0u, 0u)]
[TestCase(SendTo.ClientsAndHost, 0u, 1u)]
[TestCase(SendTo.ClientsAndHost, 0u, 2u)]
[TestCase(SendTo.ClientsAndHost, 1u, 0u)]
[TestCase(SendTo.ClientsAndHost, 1u, 1u)]
[TestCase(SendTo.ClientsAndHost, 1u, 2u)]
[TestCase(SendTo.ClientsAndHost, 2u, 0u)]
[TestCase(SendTo.ClientsAndHost, 2u, 1u)]
[TestCase(SendTo.ClientsAndHost, 2u, 2u)]
public void TestDeferLocal(
SendTo defaultSendTo,
ulong objectOwner,
ulong sender
)
private struct TestData
{
if (defaultSendTo == SendTo.ClientsAndHost && sender == 0u && !m_ServerNetworkManager.IsHost)
public SendTo SendTo;
public ulong ObjectOwner;
public ulong Sender;
public TestData(SendTo sendTo, ulong objectOwner, ulong sender)
{
// Not calling Assert.Ignore() because Unity will mark the whole block of tests as ignored
// Just consider this case a success...
return;
SendTo = sendTo;
ObjectOwner = objectOwner;
Sender = sender;
}
var sendMethodName = $"DefaultTo{defaultSendTo}DeferLocalRpc";
var verifyMethodName = $"VerifySentTo{defaultSendTo}";
var senderObject = GetPlayerObject(objectOwner, sender);
var sendMethod = senderObject.GetType().GetMethod(sendMethodName);
sendMethod.Invoke(senderObject, new object[] { new RpcParams() });
VerifyNotReceived(objectOwner, new[] { sender });
// Should be received on the next frame
SimulateOneFrame();
VerifyLocalReceived(objectOwner, sender, sendMethodName, false);
var verifyMethod = GetType().GetMethod(verifyMethodName);
verifyMethod.Invoke(this, new object[] { objectOwner, sender, sendMethodName });
}
[Test]
// All the test cases that involve sends that will be delivered locally
[TestCase(SendTo.Everyone, 0u, 0u)]
[TestCase(SendTo.Everyone, 0u, 1u)]
[TestCase(SendTo.Everyone, 0u, 2u)]
[TestCase(SendTo.Everyone, 1u, 0u)]
[TestCase(SendTo.Everyone, 1u, 1u)]
[TestCase(SendTo.Everyone, 1u, 2u)]
[TestCase(SendTo.Everyone, 2u, 0u)]
[TestCase(SendTo.Everyone, 2u, 1u)]
[TestCase(SendTo.Everyone, 2u, 2u)]
[TestCase(SendTo.Me, 0u, 0u)]
[TestCase(SendTo.Me, 0u, 1u)]
[TestCase(SendTo.Me, 0u, 2u)]
[TestCase(SendTo.Me, 1u, 0u)]
[TestCase(SendTo.Me, 1u, 1u)]
[TestCase(SendTo.Me, 1u, 2u)]
[TestCase(SendTo.Me, 2u, 0u)]
[TestCase(SendTo.Me, 2u, 1u)]
[TestCase(SendTo.Me, 2u, 2u)]
[TestCase(SendTo.Owner, 0u, 0u)]
[TestCase(SendTo.Owner, 1u, 1u)]
[TestCase(SendTo.Owner, 2u, 2u)]
[TestCase(SendTo.Server, 0u, 0u)]
[TestCase(SendTo.Server, 1u, 0u)]
[TestCase(SendTo.Server, 2u, 0u)]
[TestCase(SendTo.NotOwner, 0u, 1u)]
[TestCase(SendTo.NotOwner, 0u, 2u)]
[TestCase(SendTo.NotOwner, 1u, 0u)]
[TestCase(SendTo.NotOwner, 1u, 2u)]
[TestCase(SendTo.NotOwner, 2u, 0u)]
[TestCase(SendTo.NotOwner, 2u, 1u)]
[TestCase(SendTo.NotServer, 0u, 1u)]
[TestCase(SendTo.NotServer, 0u, 2u)]
[TestCase(SendTo.NotServer, 1u, 1u)]
[TestCase(SendTo.NotServer, 1u, 2u)]
[TestCase(SendTo.NotServer, 2u, 1u)]
[TestCase(SendTo.NotServer, 2u, 2u)]
[TestCase(SendTo.ClientsAndHost, 0u, 0u)]
[TestCase(SendTo.ClientsAndHost, 0u, 1u)]
[TestCase(SendTo.ClientsAndHost, 0u, 2u)]
[TestCase(SendTo.ClientsAndHost, 1u, 0u)]
[TestCase(SendTo.ClientsAndHost, 1u, 1u)]
[TestCase(SendTo.ClientsAndHost, 1u, 2u)]
[TestCase(SendTo.ClientsAndHost, 2u, 0u)]
[TestCase(SendTo.ClientsAndHost, 2u, 1u)]
[TestCase(SendTo.ClientsAndHost, 2u, 2u)]
public void TestDeferLocalOverrideToTrue(
SendTo defaultSendTo,
ulong objectOwner,
ulong sender
)
private static TestData[] s_LocalDeliveryTestCases =
{
if (defaultSendTo == SendTo.ClientsAndHost && sender == 0u && !m_ServerNetworkManager.IsHost)
new TestData(SendTo.Everyone, 0u, 0u),
new TestData(SendTo.Everyone, 0u, 1u),
new TestData(SendTo.Everyone, 0u, 2u),
new TestData(SendTo.Everyone, 1u, 0u),
new TestData(SendTo.Everyone, 1u, 1u),
new TestData(SendTo.Everyone, 1u, 2u),
new TestData(SendTo.Everyone, 2u, 0u),
new TestData(SendTo.Everyone, 2u, 1u),
new TestData(SendTo.Everyone, 2u, 2u),
new TestData(SendTo.Me, 0u, 0u),
new TestData(SendTo.Me, 0u, 1u),
new TestData(SendTo.Me, 0u, 2u),
new TestData(SendTo.Me, 1u, 0u),
new TestData(SendTo.Me, 1u, 1u),
new TestData(SendTo.Me, 1u, 2u),
new TestData(SendTo.Me, 2u, 0u),
new TestData(SendTo.Me, 2u, 1u),
new TestData(SendTo.Me, 2u, 2u),
new TestData(SendTo.Owner, 0u, 0u),
new TestData(SendTo.Owner, 1u, 1u),
new TestData(SendTo.Owner, 2u, 2u),
new TestData(SendTo.Server, 0u, 0u),
new TestData(SendTo.Server, 1u, 0u),
new TestData(SendTo.Server, 2u, 0u),
new TestData(SendTo.NotOwner, 0u, 1u),
new TestData(SendTo.NotOwner, 0u, 2u),
new TestData(SendTo.NotOwner, 1u, 0u),
new TestData(SendTo.NotOwner, 1u, 2u),
new TestData(SendTo.NotOwner, 2u, 0u),
new TestData(SendTo.NotOwner, 2u, 1u),
new TestData(SendTo.NotServer, 0u, 1u),
new TestData(SendTo.NotServer, 0u, 2u),
new TestData(SendTo.NotServer, 1u, 1u),
new TestData(SendTo.NotServer, 1u, 2u),
new TestData(SendTo.NotServer, 2u, 1u),
new TestData(SendTo.NotServer, 2u, 2u),
new TestData(SendTo.ClientsAndHost, 0u, 0u),
new TestData(SendTo.ClientsAndHost, 0u, 1u),
new TestData(SendTo.ClientsAndHost, 0u, 2u),
new TestData(SendTo.ClientsAndHost, 1u, 0u),
new TestData(SendTo.ClientsAndHost, 1u, 1u),
new TestData(SendTo.ClientsAndHost, 1u, 2u),
new TestData(SendTo.ClientsAndHost, 2u, 0u),
new TestData(SendTo.ClientsAndHost, 2u, 1u),
new TestData(SendTo.ClientsAndHost, 2u, 2u),
};
[UnityTest]
public IEnumerator TestDeferLocal()
{
foreach (var testCase in s_LocalDeliveryTestCases)
{
// Not calling Assert.Ignore() because Unity will mark the whole block of tests as ignored
// Just consider this case a success...
return;
if (++YieldCheck % YieldCycleCount == 0)
{
yield return null;
}
OnInlineSetup();
var defaultSendTo = testCase.SendTo;
var sender = testCase.Sender;
var objectOwner = testCase.ObjectOwner;
if (defaultSendTo == SendTo.ClientsAndHost && sender == 0u && !m_ServerNetworkManager.IsHost)
{
// Not calling Assert.Ignore() because Unity will mark the whole block of tests as ignored
// Just consider this case a success...
yield break;
}
var sendMethodName = $"DefaultTo{defaultSendTo}DeferLocalRpc";
var verifyMethodName = $"VerifySentTo{defaultSendTo}";
var senderObject = GetPlayerObject(objectOwner, sender);
var sendMethod = senderObject.GetType().GetMethod(sendMethodName);
sendMethod.Invoke(senderObject, new object[] { new RpcParams() });
VerifyNotReceived(objectOwner, new[] { sender });
// Should be received on the next frame
SimulateOneFrame();
VerifyLocalReceived(objectOwner, sender, sendMethodName, false);
var verifyMethod = GetType().GetMethod(verifyMethodName);
verifyMethod.Invoke(this, new object[] { objectOwner, sender, sendMethodName });
OnInlineTearDown();
}
var sendMethodName = $"DefaultTo{defaultSendTo}WithRpcParamsRpc";
var verifyMethodName = $"VerifySentTo{defaultSendTo}";
var senderObject = GetPlayerObject(objectOwner, sender);
var sendMethod = senderObject.GetType().GetMethod(sendMethodName);
sendMethod.Invoke(senderObject, new object[] { (RpcParams)LocalDeferMode.Defer });
VerifyNotReceived(objectOwner, new[] { sender });
// Should be received on the next frame
SimulateOneFrame();
VerifyLocalReceived(objectOwner, sender, sendMethodName, false);
var verifyMethod = GetType().GetMethod(verifyMethodName);
verifyMethod.Invoke(this, new object[] { objectOwner, sender, sendMethodName });
}
[Test]
// All the test cases that involve sends that will be delivered locally
[TestCase(SendTo.Everyone, 0u, 0u)]
[TestCase(SendTo.Everyone, 0u, 1u)]
[TestCase(SendTo.Everyone, 0u, 2u)]
[TestCase(SendTo.Everyone, 1u, 0u)]
[TestCase(SendTo.Everyone, 1u, 1u)]
[TestCase(SendTo.Everyone, 1u, 2u)]
[TestCase(SendTo.Everyone, 2u, 0u)]
[TestCase(SendTo.Everyone, 2u, 1u)]
[TestCase(SendTo.Everyone, 2u, 2u)]
[TestCase(SendTo.Me, 0u, 0u)]
[TestCase(SendTo.Me, 0u, 1u)]
[TestCase(SendTo.Me, 0u, 2u)]
[TestCase(SendTo.Me, 1u, 0u)]
[TestCase(SendTo.Me, 1u, 1u)]
[TestCase(SendTo.Me, 1u, 2u)]
[TestCase(SendTo.Me, 2u, 0u)]
[TestCase(SendTo.Me, 2u, 1u)]
[TestCase(SendTo.Me, 2u, 2u)]
[TestCase(SendTo.Owner, 0u, 0u)]
[TestCase(SendTo.Owner, 1u, 1u)]
[TestCase(SendTo.Owner, 2u, 2u)]
[TestCase(SendTo.Server, 0u, 0u)]
[TestCase(SendTo.Server, 1u, 0u)]
[TestCase(SendTo.Server, 2u, 0u)]
[TestCase(SendTo.NotOwner, 0u, 1u)]
[TestCase(SendTo.NotOwner, 0u, 2u)]
[TestCase(SendTo.NotOwner, 1u, 0u)]
[TestCase(SendTo.NotOwner, 1u, 2u)]
[TestCase(SendTo.NotOwner, 2u, 0u)]
[TestCase(SendTo.NotOwner, 2u, 1u)]
[TestCase(SendTo.NotServer, 0u, 1u)]
[TestCase(SendTo.NotServer, 0u, 2u)]
[TestCase(SendTo.NotServer, 1u, 1u)]
[TestCase(SendTo.NotServer, 1u, 2u)]
[TestCase(SendTo.NotServer, 2u, 1u)]
[TestCase(SendTo.NotServer, 2u, 2u)]
[TestCase(SendTo.ClientsAndHost, 0u, 0u)]
[TestCase(SendTo.ClientsAndHost, 0u, 1u)]
[TestCase(SendTo.ClientsAndHost, 0u, 2u)]
[TestCase(SendTo.ClientsAndHost, 1u, 0u)]
[TestCase(SendTo.ClientsAndHost, 1u, 1u)]
[TestCase(SendTo.ClientsAndHost, 1u, 2u)]
[TestCase(SendTo.ClientsAndHost, 2u, 0u)]
[TestCase(SendTo.ClientsAndHost, 2u, 1u)]
[TestCase(SendTo.ClientsAndHost, 2u, 2u)]
public void TestDeferLocalOverrideToFalse(
SendTo defaultSendTo,
ulong objectOwner,
ulong sender
)
[UnityTest]
public IEnumerator TestDeferLocalOverrideToTrue()
{
if (defaultSendTo == SendTo.ClientsAndHost && sender == 0u && !m_ServerNetworkManager.IsHost)
foreach (var testCase in s_LocalDeliveryTestCases)
{
// Not calling Assert.Ignore() because Unity will mark the whole block of tests as ignored
// Just consider this case a success...
return;
if (++YieldCheck % YieldCycleCount == 0)
{
yield return null;
}
OnInlineSetup();
var defaultSendTo = testCase.SendTo;
var sender = testCase.Sender;
var objectOwner = testCase.ObjectOwner;
if (defaultSendTo == SendTo.ClientsAndHost && sender == 0u && !m_ServerNetworkManager.IsHost)
{
// Not calling Assert.Ignore() because Unity will mark the whole block of tests as ignored
// Just consider this case a success...
yield break;
}
var sendMethodName = $"DefaultTo{defaultSendTo}WithRpcParamsRpc";
var verifyMethodName = $"VerifySentTo{defaultSendTo}";
var senderObject = GetPlayerObject(objectOwner, sender);
var sendMethod = senderObject.GetType().GetMethod(sendMethodName);
sendMethod.Invoke(senderObject, new object[] { (RpcParams)LocalDeferMode.Defer });
VerifyNotReceived(objectOwner, new[] { sender });
// Should be received on the next frame
SimulateOneFrame();
VerifyLocalReceived(objectOwner, sender, sendMethodName, false);
var verifyMethod = GetType().GetMethod(verifyMethodName);
verifyMethod.Invoke(this, new object[] { objectOwner, sender, sendMethodName });
OnInlineTearDown();
}
var sendMethodName = $"DefaultTo{defaultSendTo}DeferLocalRpc";
var verifyMethodName = $"VerifySentTo{defaultSendTo}";
var senderObject = GetPlayerObject(objectOwner, sender);
var sendMethod = senderObject.GetType().GetMethod(sendMethodName);
sendMethod.Invoke(senderObject, new object[] { (RpcParams)LocalDeferMode.SendImmediate });
}
VerifyLocalReceived(objectOwner, sender, sendMethodName, false);
[UnityTest]
public IEnumerator TestDeferLocalOverrideToFalse()
{
foreach (var testCase in s_LocalDeliveryTestCases)
{
if (++YieldCheck % YieldCycleCount == 0)
{
yield return null;
}
OnInlineSetup();
var defaultSendTo = testCase.SendTo;
var sender = testCase.Sender;
var objectOwner = testCase.ObjectOwner;
var verifyMethod = GetType().GetMethod(verifyMethodName);
verifyMethod.Invoke(this, new object[] { objectOwner, sender, sendMethodName });
if (defaultSendTo == SendTo.ClientsAndHost && sender == 0u && !m_ServerNetworkManager.IsHost)
{
// Not calling Assert.Ignore() because Unity will mark the whole block of tests as ignored
// Just consider this case a success...
yield break;
}
var sendMethodName = $"DefaultTo{defaultSendTo}DeferLocalRpc";
var verifyMethodName = $"VerifySentTo{defaultSendTo}";
var senderObject = GetPlayerObject(objectOwner, sender);
var sendMethod = senderObject.GetType().GetMethod(sendMethodName);
sendMethod.Invoke(senderObject, new object[] { (RpcParams)LocalDeferMode.SendImmediate });
VerifyLocalReceived(objectOwner, sender, sendMethodName, false);
var verifyMethod = GetType().GetMethod(verifyMethodName);
verifyMethod.Invoke(this, new object[] { objectOwner, sender, sendMethodName });
OnInlineTearDown();
}
}
}
@@ -1636,17 +1683,20 @@ namespace Unity.Netcode.RuntimeTests.UniversalRpcTests
VerifyNotReceived(NetworkManager.ServerClientId, s_ClientIds);
for (var i = 0; i < 10; ++i)
var clientListExpected = 1;
var serverListExpected = 2;
for (var i = 1; i <= 10; ++i)
{
WaitForMessageReceivedWithTimeTravel<RpcMessage>(clientList);
VerifyRemoteReceived(NetworkManager.ServerClientId, NetworkManager.ServerClientId, nameof(UniversalRpcNetworkBehaviour.MutualRecursionClientRpc), clientIdArray, false, false);
VerifyRemoteReceived(NetworkManager.ServerClientId, NetworkManager.ServerClientId, nameof(UniversalRpcNetworkBehaviour.MutualRecursionClientRpc), clientIdArray, false, false, clientListExpected);
VerifyNotReceived(NetworkManager.ServerClientId, serverIdArray);
clientListExpected *= 2;
Clear();
WaitForMessageReceivedWithTimeTravel<RpcMessage>(serverList);
VerifyRemoteReceived(NetworkManager.ServerClientId, NetworkManager.ServerClientId, nameof(UniversalRpcNetworkBehaviour.MutualRecursionServerRpc), serverIdArray, false, false);
VerifyRemoteReceived(NetworkManager.ServerClientId, NetworkManager.ServerClientId, nameof(UniversalRpcNetworkBehaviour.MutualRecursionServerRpc), serverIdArray, false, false, serverListExpected);
VerifyNotReceived(NetworkManager.ServerClientId, clientIdArray);
serverListExpected *= 2;
Clear();
}
@@ -1915,3 +1965,4 @@ namespace Unity.Netcode.RuntimeTests.UniversalRpcTests
}
}
#endif