com.unity.netcode.gameobjects@2.0.0-exp.2
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.2] - 2024-04-02 ### Added - Added updates to all internal messages to account for a distributed authority network session connection. (#2863) - Added `NetworkRigidbodyBase` that provides users with a more customizable network rigidbody, handles both `Rigidbody` and `Rigidbody2D`, and provides an option to make `NetworkTransform` use the rigid body for motion. (#2863) - For a customized `NetworkRigidbodyBase` class: - `NetworkRigidbodyBase.AutoUpdateKinematicState` provides control on whether the kinematic setting will be automatically set or not when ownership changes. - `NetworkRigidbodyBase.AutoSetKinematicOnDespawn` provides control on whether isKinematic will automatically be set to true when the associated `NetworkObject` is despawned. - `NetworkRigidbodyBase.Initialize` is a protected method that, when invoked, will initialize the instance. This includes options to: - Set whether using a `RigidbodyTypes.Rigidbody` or `RigidbodyTypes.Rigidbody2D`. - Includes additional optional parameters to set the `NetworkTransform`, `Rigidbody`, and `Rigidbody2d` to use. - Provides additional public methods: - `NetworkRigidbodyBase.GetPosition` to return the position of the `Rigidbody` or `Rigidbody2d` (depending upon its initialized setting). - `NetworkRigidbodyBase.GetRotation` to return the rotation of the `Rigidbody` or `Rigidbody2d` (depending upon its initialized setting). - `NetworkRigidbodyBase.MovePosition` to move to the position of the `Rigidbody` or `Rigidbody2d` (depending upon its initialized setting). - `NetworkRigidbodyBase.MoveRotation` to move to the rotation of the `Rigidbody` or `Rigidbody2d` (depending upon its initialized setting). - `NetworkRigidbodyBase.Move` to move to the position and rotation of the `Rigidbody` or `Rigidbody2d` (depending upon its initialized setting). - `NetworkRigidbodyBase.Move` to move to the position and rotation of the `Rigidbody` or `Rigidbody2d` (depending upon its initialized setting). - `NetworkRigidbodyBase.SetPosition` to set the position of the `Rigidbody` or `Rigidbody2d` (depending upon its initialized setting). - `NetworkRigidbodyBase.SetRotation` to set the rotation of the `Rigidbody` or `Rigidbody2d` (depending upon its initialized setting). - `NetworkRigidbodyBase.ApplyCurrentTransform` to set the position and rotation of the `Rigidbody` or `Rigidbody2d` based on the associated `GameObject` transform (depending upon its initialized setting). - `NetworkRigidbodyBase.WakeIfSleeping` to wake up the rigid body if sleeping. - `NetworkRigidbodyBase.SleepRigidbody` to put the rigid body to sleep. - `NetworkRigidbodyBase.IsKinematic` to determine if the `Rigidbody` or `Rigidbody2d` (depending upon its initialized setting) is currently kinematic. - `NetworkRigidbodyBase.SetIsKinematic` to set the `Rigidbody` or `Rigidbody2d` (depending upon its initialized setting) current kinematic state. - `NetworkRigidbodyBase.ResetInterpolation` to reset the `Rigidbody` or `Rigidbody2d` (depending upon its initialized setting) back to its original interpolation value when initialized. - Now includes a `MonoBehaviour.FixedUpdate` implementation that will update the assigned `NetworkTransform` when `NetworkRigidbodyBase.UseRigidBodyForMotion` is true. (#2863) - Added `RigidbodyContactEventManager` that provides a more optimized way to process collision enter and collision stay events as opposed to the `Monobehaviour` approach. (#2863) - Can be used in client-server and distributed authority modes, but is particularly useful in distributed authority. - Added rigid body motion updates to `NetworkTransform` which allows users to set interolation on rigid bodies. (#2863) - Extrapolation is only allowed on authoritative instances, but custom class derived from `NetworkRigidbodyBase` or `NetworkRigidbody` or `NetworkRigidbody2D` automatically switches non-authoritative instances to interpolation if set to extrapolation. - Added distributed authority mode support to `NetworkAnimator`. (#2863) - Added session mode selection to `NetworkManager` inspector view. (#2863) - Added distributed authority permissions feature. (#2863) - Added distributed authority mode specific `NetworkObject` permissions flags (Distributable, Transferable, and RequestRequired). (#2863) - Added distributed authority mode specific `NetworkObject.SetOwnershipStatus` method that applies one or more `NetworkObject` instance's ownership flags. If updated when spawned, the ownership permission changes are synchronized with the other connected clients. (#2863) - Added distributed authority mode specific `NetworkObject.RemoveOwnershipStatus` method that removes one or more `NetworkObject` instance's ownership flags. If updated when spawned, the ownership permission changes are synchronized with the other connected clients. (#2863) - Added distributed authority mode specific `NetworkObject.HasOwnershipStatus` method that will return (true or false) whether one or more ownership flags is set. (#2863) - Added distributed authority mode specific `NetworkObject.SetOwnershipLock` method that locks ownership of a `NetworkObject` to prevent ownership from changing until the current owner releases the lock. (#2863) - Added distributed authority mode specific `NetworkObject.RequestOwnership` method that sends an ownership request to the current owner of a spawned `NetworkObject` instance. (#2863) - Added distributed authority mode specific `NetworkObject.OnOwnershipRequested` callback handler that is invoked on the owner/authoritative side when a non-owner requests ownership. Depending upon the boolean returned value depends upon whether the request is approved or denied. (#2863) - Added distributed authority mode specific `NetworkObject.OnOwnershipRequestResponse` callback handler that is invoked when a non-owner's request has been processed. This callback includes a `NetworkObjet.OwnershipRequestResponseStatus` response parameter that describes whether the request was approved or the reason why it was not approved. (#2863) - Added distributed authority mode specific `NetworkObject.DeferDespawn` method that defers the despawning of `NetworkObject` instances on non-authoritative clients based on the tick offset parameter. (#2863) - Added distributed authority mode specific `NetworkObject.OnDeferredDespawnComplete` callback handler that can be used to further control when deferring the despawning of a `NetworkObject` on non-authoritative instances. (#2863) - Added `NetworkClient.SessionModeType` as one way to determine the current session mode of the network session a client is connected to. (#2863) - Added distributed authority mode specific `NetworkClient.IsSessionOwner` property to determine if the current local client is the current session owner of a distributed authority session. (#2863) - Added distributed authority mode specific client side spawning capabilities. When running in distributed authority mode, clients can instantiate and spawn `NetworkObject` instances (the local client is authomatically the owner of the spawned object). (#2863) - This is useful to better visually synchronize owner authoritative motion models and newly spawned `NetworkObject` instances (i.e. projectiles for example). - Added distributed authority mode specific client side player spawning capabilities. Clients will automatically spawn their associated player object locally. (#2863) - Added distributed authority mode specific `NetworkConfig.AutoSpawnPlayerPrefabClientSide` property (default is true) to provide control over the automatic spawning of player prefabs on the local client side. (#2863) - Added distributed authority mode specific `NetworkManager.OnFetchLocalPlayerPrefabToSpawn` callback that, when assigned, will allow the local client to provide the player prefab to be spawned for the local client. (#2863) - This is only invoked if the `NetworkConfig.AutoSpawnPlayerPrefabClientSide` property is set to true. - Added distributed authority mode specific `NetworkBehaviour.HasAuthority` property that determines if the local client has authority over the associated `NetworkObject` instance (typical use case is within a `NetworkBehaviour` script much like that of `IsServer` or `IsClient`). (#2863) - Added distributed authority mode specific `NetworkBehaviour.IsSessionOwner` property that determines if the local client is the session owner (typical use case would be to determine if the local client can has scene management authority within a `NetworkBehaviour` script). (#2863) - Added support for distributed authority mode scene management where the currently assigned session owner can start scene events (i.e. scene loading and scene unloading). (#2863) ### Fixed - 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 client side awareness of other clients is now the same as a server or host. (#2863) - Changed `NetworkManager.ConnectedClients` can now be accessed by both server and clients. (#2863) - Changed `NetworkManager.ConnectedClientsList` can now be accessed by both server and clients. (#2863) - Changed `NetworkTransform` defaults to owner authoritative when connected to a distributed authority session. (#2863) - Changed `NetworkVariable` defaults to owner write and everyone read permissions when connected to a distributed authority session (even if declared with server read or write permissions). (#2863) - Changed `NetworkObject` no longer implements the `MonoBehaviour.Update` method in order to determine whether a `NetworkObject` instance has been migrated to a different scene. Instead, only `NetworkObjects` with the `SceneMigrationSynchronization` property set will be updated internally during the `NetworkUpdateStage.PostLateUpdate` by `NetworkManager`. (#2863) - Changed `NetworkManager` inspector view layout where properties are now organized by category. (#2863) - 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
@@ -14,33 +14,6 @@ namespace Unity.Netcode.RuntimeTests
|
||||
/// </summary>
|
||||
public class NetVarContainer : NetworkBehaviour
|
||||
{
|
||||
/// <summary>
|
||||
/// Creates a prefab with two instances of this NetworkBehaviour
|
||||
/// </summary>
|
||||
/// <returns></returns>
|
||||
public static GameObject CreatePrefabGameObject(NetVarCombinationTypes netVarsToCheck)
|
||||
{
|
||||
var gameObject = new GameObject
|
||||
{
|
||||
// Always a good idea to name the Prefab for easy identification purposes
|
||||
name = "NetVarContainerObject"
|
||||
};
|
||||
var networkObject = gameObject.AddComponent<NetworkObject>();
|
||||
|
||||
// Create the two instances of the NetVarContainer components and add them to the
|
||||
// GameObject of this prefab
|
||||
var netVarContainer = gameObject.AddComponent<NetVarContainer>();
|
||||
netVarContainer.NumberOfNetVarsToCheck = netVarsToCheck.FirstType;
|
||||
netVarContainer.ValueToSetNetVarTo = NetworkBehaviourUpdaterTests.NetVarValueToSet;
|
||||
netVarContainer = gameObject.AddComponent<NetVarContainer>();
|
||||
netVarContainer.NumberOfNetVarsToCheck = netVarsToCheck.SecondType;
|
||||
netVarContainer.ValueToSetNetVarTo = NetworkBehaviourUpdaterTests.NetVarValueToSet;
|
||||
|
||||
NetcodeIntegrationTestHelpers.MakeNetworkObjectTestPrefab(networkObject);
|
||||
|
||||
return gameObject;
|
||||
}
|
||||
|
||||
public enum NetVarsToCheck
|
||||
{
|
||||
One,
|
||||
@@ -106,10 +79,16 @@ namespace Unity.Netcode.RuntimeTests
|
||||
private NetworkVariable<int> m_FirstValue = new NetworkVariable<int>();
|
||||
private NetworkVariable<int> m_SeconValue = new NetworkVariable<int>();
|
||||
|
||||
public void SetOwnerWrite()
|
||||
{
|
||||
m_FirstValue = new NetworkVariable<int>(default, NetworkVariableReadPermission.Everyone, NetworkVariableWritePermission.Owner);
|
||||
m_SeconValue = new NetworkVariable<int>(default, NetworkVariableReadPermission.Everyone, NetworkVariableWritePermission.Owner);
|
||||
}
|
||||
|
||||
public override void OnNetworkSpawn()
|
||||
{
|
||||
// Clients will register each NetworkObject when it is spawned
|
||||
if (!IsServer)
|
||||
// Non-Authority will register each NetworkObject when it is spawned
|
||||
if ((NetworkManager.DistributedAuthorityMode && !IsOwner) || (!NetworkManager.DistributedAuthorityMode && !IsServer))
|
||||
{
|
||||
NetworkBehaviourUpdaterTests.ClientSideNotifyObjectSpawned(gameObject);
|
||||
}
|
||||
@@ -121,7 +100,7 @@ namespace Unity.Netcode.RuntimeTests
|
||||
/// </summary>
|
||||
public void SetNetworkVariableValues()
|
||||
{
|
||||
if (IsServer)
|
||||
if ((NetworkManager.DistributedAuthorityMode && IsOwner) || (!NetworkManager.DistributedAuthorityMode && IsServer))
|
||||
{
|
||||
switch (NumberOfNetVarsToCheck)
|
||||
{
|
||||
@@ -153,13 +132,56 @@ namespace Unity.Netcode.RuntimeTests
|
||||
public NetVarContainer.NetVarsToCheck SecondType;
|
||||
}
|
||||
|
||||
/// <summary>
|
||||
/// Server and Distributed Authority modes require at least 1 client while the host does not.
|
||||
/// </summary>
|
||||
/// [Session Mode][Number of Clients][First NetVar Type][Second NetVar Type]
|
||||
[TestFixture(HostOrServer.DAHost, 1, NetVarContainer.NetVarsToCheck.One, NetVarContainer.NetVarsToCheck.One)]
|
||||
[TestFixture(HostOrServer.DAHost, 1, NetVarContainer.NetVarsToCheck.One, NetVarContainer.NetVarsToCheck.Two)]
|
||||
[TestFixture(HostOrServer.DAHost, 1, NetVarContainer.NetVarsToCheck.Two, NetVarContainer.NetVarsToCheck.Two)]
|
||||
[TestFixture(HostOrServer.DAHost, 2, NetVarContainer.NetVarsToCheck.One, NetVarContainer.NetVarsToCheck.One)]
|
||||
[TestFixture(HostOrServer.DAHost, 2, NetVarContainer.NetVarsToCheck.One, NetVarContainer.NetVarsToCheck.Two)]
|
||||
[TestFixture(HostOrServer.DAHost, 2, NetVarContainer.NetVarsToCheck.Two, NetVarContainer.NetVarsToCheck.Two)]
|
||||
[TestFixture(HostOrServer.Server, 1, NetVarContainer.NetVarsToCheck.One, NetVarContainer.NetVarsToCheck.One)]
|
||||
[TestFixture(HostOrServer.Server, 1, NetVarContainer.NetVarsToCheck.One, NetVarContainer.NetVarsToCheck.Two)]
|
||||
[TestFixture(HostOrServer.Server, 1, NetVarContainer.NetVarsToCheck.Two, NetVarContainer.NetVarsToCheck.Two)]
|
||||
[TestFixture(HostOrServer.Server, 2, NetVarContainer.NetVarsToCheck.One, NetVarContainer.NetVarsToCheck.One)]
|
||||
[TestFixture(HostOrServer.Server, 2, NetVarContainer.NetVarsToCheck.One, NetVarContainer.NetVarsToCheck.Two)]
|
||||
[TestFixture(HostOrServer.Server, 2, NetVarContainer.NetVarsToCheck.Two, NetVarContainer.NetVarsToCheck.Two)]
|
||||
[TestFixture(HostOrServer.Host, 0, NetVarContainer.NetVarsToCheck.One, NetVarContainer.NetVarsToCheck.One)]
|
||||
[TestFixture(HostOrServer.Host, 0, NetVarContainer.NetVarsToCheck.One, NetVarContainer.NetVarsToCheck.Two)]
|
||||
[TestFixture(HostOrServer.Host, 0, NetVarContainer.NetVarsToCheck.Two, NetVarContainer.NetVarsToCheck.Two)]
|
||||
[TestFixture(HostOrServer.Host, 1, NetVarContainer.NetVarsToCheck.One, NetVarContainer.NetVarsToCheck.One)]
|
||||
[TestFixture(HostOrServer.Host, 1, NetVarContainer.NetVarsToCheck.One, NetVarContainer.NetVarsToCheck.Two)]
|
||||
[TestFixture(HostOrServer.Host, 1, NetVarContainer.NetVarsToCheck.Two, NetVarContainer.NetVarsToCheck.Two)]
|
||||
[TestFixture(HostOrServer.Host, 2, NetVarContainer.NetVarsToCheck.One, NetVarContainer.NetVarsToCheck.One)]
|
||||
[TestFixture(HostOrServer.Host, 2, NetVarContainer.NetVarsToCheck.One, NetVarContainer.NetVarsToCheck.Two)]
|
||||
[TestFixture(HostOrServer.Host, 2, NetVarContainer.NetVarsToCheck.Two, NetVarContainer.NetVarsToCheck.Two)]
|
||||
public class NetworkBehaviourUpdaterTests : NetcodeIntegrationTest
|
||||
{
|
||||
// Go ahead and create maximum number of clients (not all tests will use them)
|
||||
protected override int NumberOfClients => 2;
|
||||
protected override int NumberOfClients => m_NumberOfClients;
|
||||
public const int NetVarValueToSet = 1;
|
||||
private static List<GameObject> s_ClientSpawnedNetworkObjects = new List<GameObject>();
|
||||
private List<NetworkManager> m_ActiveClientsForCurrentTest;
|
||||
private GameObject m_PrefabToSpawn;
|
||||
private NetVarCombinationTypes m_NetVarCombinationTypes;
|
||||
private int m_NumberOfClients = 0;
|
||||
|
||||
public NetworkBehaviourUpdaterTests(HostOrServer hostOrServer, int numberOfClients, NetVarContainer.NetVarsToCheck first, NetVarContainer.NetVarsToCheck second) : base(hostOrServer)
|
||||
{
|
||||
m_NetVarCombinationTypes = new NetVarCombinationTypes()
|
||||
{
|
||||
FirstType = first,
|
||||
SecondType = second
|
||||
};
|
||||
m_NumberOfClients = numberOfClients;
|
||||
}
|
||||
|
||||
protected override IEnumerator OnSetup()
|
||||
{
|
||||
s_ClientSpawnedNetworkObjects.Clear();
|
||||
return base.OnSetup();
|
||||
}
|
||||
|
||||
/// <summary>
|
||||
/// Clients will call this when NetworkObjects are spawned on their end
|
||||
@@ -173,70 +195,32 @@ namespace Unity.Netcode.RuntimeTests
|
||||
}
|
||||
}
|
||||
|
||||
protected override bool CanStartServerAndClients()
|
||||
protected override void OnServerAndClientsCreated()
|
||||
{
|
||||
return false;
|
||||
m_PrefabToSpawn = CreateNetworkObjectPrefab("NetVarCont");
|
||||
// Create the two instances of the NetVarContainer components and add them to the
|
||||
// GameObject of this prefab
|
||||
var netVarContainer = m_PrefabToSpawn.AddComponent<NetVarContainer>();
|
||||
netVarContainer.NumberOfNetVarsToCheck = m_NetVarCombinationTypes.FirstType;
|
||||
if (m_SessionModeType == SessionModeTypes.DistributedAuthority)
|
||||
{
|
||||
netVarContainer.SetOwnerWrite();
|
||||
}
|
||||
|
||||
netVarContainer.ValueToSetNetVarTo = NetVarValueToSet;
|
||||
netVarContainer = m_PrefabToSpawn.AddComponent<NetVarContainer>();
|
||||
|
||||
if (m_SessionModeType == SessionModeTypes.DistributedAuthority)
|
||||
{
|
||||
netVarContainer.SetOwnerWrite();
|
||||
}
|
||||
|
||||
netVarContainer.NumberOfNetVarsToCheck = m_NetVarCombinationTypes.SecondType;
|
||||
netVarContainer.ValueToSetNetVarTo = NetVarValueToSet;
|
||||
|
||||
base.OnServerAndClientsCreated();
|
||||
}
|
||||
|
||||
/// <summary>
|
||||
/// Creates the server and client(s) required for this particular test iteration
|
||||
/// </summary>
|
||||
private IEnumerator StartClientsAndServer(bool useHost, int numberOfClients, GameObject prefabObject)
|
||||
{
|
||||
void AddNetworkPrefab(NetworkConfig config, NetworkPrefab prefab)
|
||||
{
|
||||
config.Prefabs.Add(prefab);
|
||||
}
|
||||
|
||||
// Sanity check to make sure we are not trying to create more clients than we have available to use
|
||||
Assert.True(numberOfClients <= m_ClientNetworkManagers.Length);
|
||||
m_ActiveClientsForCurrentTest = new List<NetworkManager>();
|
||||
|
||||
// Create a list of the clients to be used in this test from the available clients
|
||||
for (int i = 0; i < numberOfClients; i++)
|
||||
{
|
||||
m_ActiveClientsForCurrentTest.Add(m_ClientNetworkManagers[i]);
|
||||
}
|
||||
|
||||
// Add the prefab to be used for this particular test iteration
|
||||
var np = new NetworkPrefab { Prefab = prefabObject };
|
||||
AddNetworkPrefab(m_ServerNetworkManager.NetworkConfig, np);
|
||||
m_ServerNetworkManager.NetworkConfig.TickRate = 30;
|
||||
foreach (var clientManager in m_ActiveClientsForCurrentTest)
|
||||
{
|
||||
m_ServerNetworkManager.NetworkConfig.TickRate = 30;
|
||||
AddNetworkPrefab(clientManager.NetworkConfig, np);
|
||||
}
|
||||
|
||||
// Now spin everything up normally
|
||||
var clientsAsArry = m_ActiveClientsForCurrentTest.ToArray();
|
||||
Assert.True(NetcodeIntegrationTestHelpers.Start(useHost, m_ServerNetworkManager, clientsAsArry), "Failed to start server and client instances");
|
||||
|
||||
// Only if we have clients (not host)
|
||||
if (numberOfClients > 0)
|
||||
{
|
||||
RegisterSceneManagerHandler();
|
||||
}
|
||||
|
||||
// Wait for connection on client and server side
|
||||
yield return WaitForClientsConnectedOrTimeOut(clientsAsArry);
|
||||
}
|
||||
|
||||
/// <summary>
|
||||
/// This list replaces the original NetworkVariable types to be checked.
|
||||
/// Both NetworkVariables are of type int and the original version of this test was testing
|
||||
/// the NetworkBehaviour Update when there were 1 or more (i.e two) on the same NetworkBehaviour.
|
||||
/// After reviewing, we really only needed to test a much smaller combination of types and so
|
||||
/// this pre-generated array represents the reduced set of combinations to test.
|
||||
/// Note:
|
||||
/// The original test was also testing for no NetworkVariables of type int, which there ended up
|
||||
/// being no reason to do that and only added to the length of the execution time for this test.
|
||||
/// </summary>
|
||||
public static NetVarCombinationTypes[] NetVarCombinationTypeValues = new[]{
|
||||
new NetVarCombinationTypes() { FirstType = NetVarContainer.NetVarsToCheck.One, SecondType = NetVarContainer.NetVarsToCheck.One },
|
||||
new NetVarCombinationTypes() { FirstType = NetVarContainer.NetVarsToCheck.One, SecondType = NetVarContainer.NetVarsToCheck.Two },
|
||||
new NetVarCombinationTypes() { FirstType = NetVarContainer.NetVarsToCheck.Two, SecondType = NetVarContainer.NetVarsToCheck.Two }};
|
||||
|
||||
/// <summary>
|
||||
/// The updated BehaviourUpdaterAllTests was re-designed to replicate the same functionality being tested in the
|
||||
/// original version of this test with additional time out handling and a re-organization in the order of operations.
|
||||
@@ -246,59 +230,36 @@ namespace Unity.Netcode.RuntimeTests
|
||||
/// version like the desktop tests use).
|
||||
/// This update also updated how the server and clients were being constructed to help reduce the execution time.
|
||||
/// </summary>
|
||||
/// <param name="useHost"> whether to run the server as a host or not</param>
|
||||
/// <param name="varCombinationTypes">the NetworkVariable combination types</param>
|
||||
/// <param name="nbClients"> number of clients to use for the test</param>
|
||||
/// <param name="hostOrServer"> whether to run the server as a host or not</param>
|
||||
/// <param name="numToSpawn"> number of NetworkObjects to be spawned</param>
|
||||
[UnityTest]
|
||||
public IEnumerator BehaviourUpdaterAllTests([Values] bool useHost,
|
||||
[ValueSource(nameof(NetVarCombinationTypeValues))] NetVarCombinationTypes varCombinationTypes,
|
||||
[Values(0, 1, 2)] int nbClients, [Values(1, 2)] int numToSpawn)
|
||||
public IEnumerator BehaviourUpdaterAllTests([Values(1, 2)] int numToSpawn)
|
||||
{
|
||||
s_ClientSpawnedNetworkObjects.Clear();
|
||||
|
||||
// The edge case scenario where we can exit early is when we are running
|
||||
// just the server (i.e. non-host) and there are zero clients. Under this
|
||||
// edge case scenario of the various combinations we do not need to run
|
||||
// this test as the IsDirty flag is never cleared when no clients exist at all.
|
||||
if (nbClients == 0 && !useHost)
|
||||
{
|
||||
yield break;
|
||||
}
|
||||
|
||||
// Create our prefab based on the NetVarCombinationTypes
|
||||
var prefabToSpawn = NetVarContainer.CreatePrefabGameObject(varCombinationTypes);
|
||||
|
||||
yield return StartClientsAndServer(useHost, nbClients, prefabToSpawn);
|
||||
|
||||
// Tracks the server-side spawned prefab instances
|
||||
var spawnedPrefabs = new List<GameObject>();
|
||||
var tickInterval = 1.0f / m_ServerNetworkManager.NetworkConfig.TickRate;
|
||||
|
||||
// Used to determine if the client-side checks of this test should be
|
||||
// executed or not as well is used to make sure all clients have spawned
|
||||
// the appropriate number of NetworkObjects with the NetVarContainer behaviour
|
||||
var numberOfObjectsToSpawnOnClients = numToSpawn * nbClients;
|
||||
var numberOfObjectsToSpawn = numToSpawn * NumberOfClients;
|
||||
|
||||
var authority = m_SessionModeType == SessionModeTypes.DistributedAuthority ? m_ClientNetworkManagers[0] : m_ServerNetworkManager;
|
||||
|
||||
// spawn the objects
|
||||
for (int i = 0; i < numToSpawn; i++)
|
||||
{
|
||||
var spawnedObject = Object.Instantiate(prefabToSpawn);
|
||||
var spawnedObject = Object.Instantiate(m_PrefabToSpawn);
|
||||
spawnedPrefabs.Add(spawnedObject);
|
||||
var networkSpawnedObject = spawnedObject.GetComponent<NetworkObject>();
|
||||
networkSpawnedObject.NetworkManagerOwner = m_ServerNetworkManager;
|
||||
networkSpawnedObject.NetworkManagerOwner = authority;
|
||||
networkSpawnedObject.Spawn();
|
||||
}
|
||||
|
||||
// When there are no clients (excluding when server is in host mode), we can skip all of this
|
||||
// wait until all objects are spawned on the clients
|
||||
if (numberOfObjectsToSpawnOnClients > 0)
|
||||
{
|
||||
// Waits for all clients to spawn the NetworkObjects
|
||||
yield return WaitForConditionOrTimeOut(() => numberOfObjectsToSpawnOnClients == s_ClientSpawnedNetworkObjects.Count);
|
||||
Assert.IsFalse(s_GlobalTimeoutHelper.TimedOut, $"Timed out waiting for clients to report spawning objects! " +
|
||||
$"Total reported client-side spawned objects {s_ClientSpawnedNetworkObjects.Count}");
|
||||
}
|
||||
// Waits for all clients to spawn the NetworkObjects
|
||||
yield return WaitForConditionOrTimeOut(() => numberOfObjectsToSpawn == s_ClientSpawnedNetworkObjects.Count);
|
||||
Assert.IsFalse(s_GlobalTimeoutHelper.TimedOut, $"Timed out waiting for clients to report spawning objects! " +
|
||||
$"Total reported client-side spawned objects {s_ClientSpawnedNetworkObjects.Count}");
|
||||
|
||||
|
||||
// Once all clients have spawned the NetworkObjects, set the network variables for
|
||||
// those NetworkObjects on the server-side.
|
||||
@@ -312,39 +273,33 @@ namespace Unity.Netcode.RuntimeTests
|
||||
}
|
||||
|
||||
// Update the NetworkBehaviours to make sure all network variables are no longer marked as dirty
|
||||
m_ServerNetworkManager.BehaviourUpdater.NetworkBehaviourUpdate();
|
||||
authority.BehaviourUpdater.NetworkBehaviourUpdate();
|
||||
|
||||
// Verify that all network variables are no longer dirty on server side only if we have clients (including host)
|
||||
foreach (var serverSpawnedObject in spawnedPrefabs)
|
||||
foreach (var spawnedPrefab in spawnedPrefabs)
|
||||
{
|
||||
var netVarContainers = serverSpawnedObject.GetComponents<NetVarContainer>();
|
||||
var netVarContainers = spawnedPrefab.GetComponents<NetVarContainer>();
|
||||
foreach (var netVarContainer in netVarContainers)
|
||||
{
|
||||
Assert.False(netVarContainer.AreNetVarsDirty(), "Some NetworkVariables were still marked dirty after NetworkBehaviourUpdate!");
|
||||
}
|
||||
}
|
||||
|
||||
// When there are no clients (excluding when server is in host mode), we can skip all of this
|
||||
if (numberOfObjectsToSpawnOnClients > 0)
|
||||
// Get a list of all NetVarContainer components on the client-side spawned NetworkObjects
|
||||
var clientSideNetVarContainers = new List<NetVarContainer>();
|
||||
foreach (var clientSpawnedObjects in s_ClientSpawnedNetworkObjects)
|
||||
{
|
||||
// Get a list of all NetVarContainer components on the client-side spawned NetworkObjects
|
||||
var clientSideNetVarContainers = new List<NetVarContainer>();
|
||||
foreach (var clientSpawnedObjects in s_ClientSpawnedNetworkObjects)
|
||||
var netVarContainers = clientSpawnedObjects.GetComponents<NetVarContainer>();
|
||||
foreach (var netvarContiner in netVarContainers)
|
||||
{
|
||||
var netVarContainers = clientSpawnedObjects.GetComponents<NetVarContainer>();
|
||||
foreach (var netvarContiner in netVarContainers)
|
||||
{
|
||||
clientSideNetVarContainers.Add(netvarContiner);
|
||||
}
|
||||
clientSideNetVarContainers.Add(netvarContiner);
|
||||
}
|
||||
|
||||
yield return WaitForConditionOrTimeOut(() =>
|
||||
clientSideNetVarContainers.Where(d =>
|
||||
d.HaveAllValuesChanged(NetVarValueToSet)).Count() == clientSideNetVarContainers.Count);
|
||||
Assert.IsFalse(s_GlobalTimeoutHelper.TimedOut, $"Timed out waiting for client side NetVarContainers to report all NetworkVariables have been updated!");
|
||||
}
|
||||
|
||||
Object.DestroyImmediate(prefabToSpawn);
|
||||
yield return WaitForConditionOrTimeOut(() =>
|
||||
clientSideNetVarContainers.Where(d =>
|
||||
d.HaveAllValuesChanged(NetVarValueToSet)).Count() == clientSideNetVarContainers.Count);
|
||||
Assert.IsFalse(s_GlobalTimeoutHelper.TimedOut, $"Timed out waiting for client side NetVarContainers to report all NetworkVariables have been updated!");
|
||||
}
|
||||
}
|
||||
}
|
||||
|
||||
Reference in New Issue
Block a user