com.unity.netcode.gameobjects@1.8.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.8.0] - 2023-12-12 ### Added - Added a new RPC attribute, which is simply `Rpc`. (#2762) - This is a generic attribute that can perform the functions of both Server and Client RPCs, as well as enabling client-to-client RPCs. Includes several default targets: `Server`, `NotServer`, `Owner`, `NotOwner`, `Me`, `NotMe`, `ClientsAndHost`, and `Everyone`. Runtime overrides are available for any of these targets, as well as for sending to a specific ID or groups of IDs. - This attribute also includes the ability to defer RPCs that are sent to the local process to the start of the next frame instead of executing them immediately, treating them as if they had gone across the network. The default behavior is to execute immediately. - This attribute effectively replaces `ServerRpc` and `ClientRpc`. `ServerRpc` and `ClientRpc` remain in their existing forms for backward compatibility, but `Rpc` will be the recommended and most supported option. - Added `NetworkManager.OnConnectionEvent` as a unified connection event callback to notify clients and servers of all client connections and disconnections within the session (#2762) - Added `NetworkManager.ServerIsHost` and `NetworkBehaviour.ServerIsHost` to allow a client to tell if it is connected to a host or to a dedicated server (#2762) - Added `SceneEventProgress.SceneManagementNotEnabled` return status to be returned when a `NetworkSceneManager` method is invoked and scene management is not enabled. (#2735) - Added `SceneEventProgress.ServerOnlyAction` return status to be returned when a `NetworkSceneManager` method is invoked by a client. (#2735) - Added `NetworkObject.InstantiateAndSpawn` and `NetworkSpawnManager.InstantiateAndSpawn` methods to simplify prefab spawning by assuring that the prefab is valid and applies any override prior to instantiating the `GameObject` and spawning the `NetworkObject` instance. (#2710) ### Fixed - Fixed issue where a client disconnected by a server-host would not receive a local notification. (#2789) - Fixed issue where a server-host could shutdown during a relay connection but periodically the transport disconnect message sent to any connected clients could be dropped. (#2789) - Fixed issue where a host could disconnect its local client but remain running as a server. (#2789) - Fixed issue where `OnClientDisconnectedCallback` was not being invoked under certain conditions. (#2789) - Fixed issue where `OnClientDisconnectedCallback` was always returning 0 as the client identifier. (#2789) - Fixed issue where if a host or server shutdown while a client owned NetworkObjects (other than the player) it would throw an exception. (#2789) - Fixed issue where setting values on a `NetworkVariable` or `NetworkList` within `OnNetworkDespawn` during a shutdown sequence would throw an exception. (#2789) - Fixed issue where a teleport state could potentially be overridden by a previous unreliable delta state. (#2777) - Fixed issue where `NetworkTransform` was using the `NetworkManager.ServerTime.Tick` as opposed to `NetworkManager.NetworkTickSystem.ServerTime.Tick` during the authoritative side's tick update where it performed a delta state check. (#2777) - Fixed issue where a parented in-scene placed NetworkObject would be destroyed upon a client or server exiting a network session but not unloading the original scene in which the NetworkObject was placed. (#2737) - Fixed issue where during client synchronization and scene loading, when client synchronization or the scene loading mode are set to `LoadSceneMode.Single`, a `CreateObjectMessage` could be received, processed, and the resultant spawned `NetworkObject` could be instantiated in the client's currently active scene that could, towards the end of the client synchronization or loading process, be unloaded and cause the newly created `NetworkObject` to be destroyed (and throw and exception). (#2735) - Fixed issue where a `NetworkTransform` instance with interpolation enabled would result in wide visual motion gaps (stuttering) under above normal latency conditions and a 1-5% or higher packet are drop rate. (#2713) - Fixed issue where you could not have multiple source network prefab overrides targeting the same network prefab as their override. (#2710) ### Changed - Changed the server or host shutdown so it will now perform a "soft shutdown" when `NetworkManager.Shutdown` is invoked. This will send a disconnect notification to all connected clients and the server-host will wait for all connected clients to disconnect or timeout after a 5 second period before completing the shutdown process. (#2789) - Changed `OnClientDisconnectedCallback` will now return the assigned client identifier on the local client side if the client was approved and assigned one prior to being disconnected. (#2789) - Changed `NetworkTransform.SetState` (and related methods) now are cumulative during a fractional tick period and sent on the next pending tick. (#2777) - `NetworkManager.ConnectedClientsIds` is now accessible on the client side and will contain the list of all clients in the session, including the host client if the server is operating in host mode (#2762) - Changed `NetworkSceneManager` to return a `SceneEventProgress` status and not throw exceptions for methods invoked when scene management is disabled and when a client attempts to access a `NetworkSceneManager` method by a client. (#2735) - Changed `NetworkTransform` authoritative instance tick registration so a single `NetworkTransform` specific tick event update will update all authoritative instances to improve perofmance. (#2713) - Changed `NetworkPrefabs.OverrideToNetworkPrefab` dictionary is no longer used/populated due to it ending up being related to a regression bug and not allowing more than one override to be assigned to a network prefab asset. (#2710) - Changed in-scene placed `NetworkObject`s now store their source network prefab asset's `GlobalObjectIdHash` internally that is used, when scene management is disabled, by clients to spawn the correct prefab even if the `NetworkPrefab` entry has an override. This does not impact dynamically spawning the same prefab which will yield the override on both host and client. (#2710) - Changed in-scene placed `NetworkObject`s no longer require a `NetworkPrefab` entry with `GlobalObjectIdHash` override in order for clients to properly synchronize. (#2710) - Changed in-scene placed `NetworkObject`s now set their `IsSceneObject` value when generating their `GlobalObjectIdHash` value. (#2710) - Changed the default `NetworkConfig.SpawnTimeout` value from 1.0s to 10.0s. (#2710)
This commit is contained in:
Unity Technologies
@@ -10,111 +10,104 @@ namespace Unity.Netcode.RuntimeTests
|
||||
/// <summary>
|
||||
/// Tests that check OnNetworkDespawn being invoked
|
||||
/// </summary>
|
||||
public class NetworkObjectOnNetworkDespawnTests
|
||||
[TestFixture(HostOrServer.Host)]
|
||||
[TestFixture(HostOrServer.Server)]
|
||||
public class NetworkObjectOnNetworkDespawnTests : NetcodeIntegrationTest
|
||||
{
|
||||
private NetworkManager m_ServerHost;
|
||||
private NetworkManager[] m_Clients;
|
||||
private const string k_ObjectName = "TestDespawn";
|
||||
public enum InstanceType
|
||||
{
|
||||
Server,
|
||||
Client
|
||||
}
|
||||
|
||||
protected override int NumberOfClients => 1;
|
||||
private GameObject m_ObjectToSpawn;
|
||||
private NetworkObject m_NetworkObject;
|
||||
private HostOrServer m_HostOrServer;
|
||||
public NetworkObjectOnNetworkDespawnTests(HostOrServer hostOrServer) : base(hostOrServer)
|
||||
{
|
||||
m_HostOrServer = hostOrServer;
|
||||
}
|
||||
|
||||
internal class OnNetworkDespawnTestComponent : NetworkBehaviour
|
||||
{
|
||||
public bool OnNetworkDespawnCalled { get; internal set; }
|
||||
public static bool OnServerNetworkDespawnCalled { get; internal set; }
|
||||
public static bool OnClientNetworkDespawnCalled { get; internal set; }
|
||||
|
||||
public override void OnNetworkSpawn()
|
||||
{
|
||||
OnNetworkDespawnCalled = false;
|
||||
if (IsServer)
|
||||
{
|
||||
OnServerNetworkDespawnCalled = false;
|
||||
}
|
||||
else
|
||||
{
|
||||
OnClientNetworkDespawnCalled = false;
|
||||
}
|
||||
base.OnNetworkSpawn();
|
||||
}
|
||||
|
||||
public override void OnNetworkDespawn()
|
||||
{
|
||||
OnNetworkDespawnCalled = true;
|
||||
if (IsServer)
|
||||
{
|
||||
OnServerNetworkDespawnCalled = true;
|
||||
}
|
||||
else
|
||||
{
|
||||
OnClientNetworkDespawnCalled = true;
|
||||
}
|
||||
base.OnNetworkDespawn();
|
||||
}
|
||||
}
|
||||
|
||||
[UnitySetUp]
|
||||
public IEnumerator Setup()
|
||||
protected override void OnServerAndClientsCreated()
|
||||
{
|
||||
Assert.IsTrue(NetcodeIntegrationTestHelpers.Create(1, out m_ServerHost, out m_Clients));
|
||||
|
||||
m_ObjectToSpawn = NetcodeIntegrationTestHelpers.CreateNetworkObjectPrefab(nameof(NetworkObjectOnNetworkDespawnTests), m_ServerHost, m_Clients);
|
||||
m_ObjectToSpawn = CreateNetworkObjectPrefab(k_ObjectName);
|
||||
m_ObjectToSpawn.AddComponent<OnNetworkDespawnTestComponent>();
|
||||
m_NetworkObject = m_ObjectToSpawn.GetComponent<NetworkObject>();
|
||||
|
||||
yield return null;
|
||||
}
|
||||
|
||||
[UnityTearDown]
|
||||
public IEnumerator Teardown()
|
||||
{
|
||||
// Shutdown and clean up both of our NetworkManager instances
|
||||
if (m_ObjectToSpawn)
|
||||
{
|
||||
Object.Destroy(m_ObjectToSpawn);
|
||||
m_ObjectToSpawn = null;
|
||||
}
|
||||
NetcodeIntegrationTestHelpers.Destroy();
|
||||
yield return null;
|
||||
}
|
||||
|
||||
public enum InstanceType
|
||||
{
|
||||
Server,
|
||||
Host,
|
||||
Client
|
||||
base.OnServerAndClientsCreated();
|
||||
}
|
||||
|
||||
/// <summary>
|
||||
/// Tests that a spawned NetworkObject's associated NetworkBehaviours will have
|
||||
/// their OnNetworkDespawn invoked during NetworkManager shutdown.
|
||||
/// This test validates that <see cref="NetworkBehaviour.OnNetworkDespawn"/> is invoked when the
|
||||
/// <see cref="NetworkManager"/> is shutdown.
|
||||
/// </summary>
|
||||
[UnityTest]
|
||||
public IEnumerator TestNetworkObjectDespawnOnShutdown([Values(InstanceType.Server, InstanceType.Host, InstanceType.Client)] InstanceType despawnCheck)
|
||||
public IEnumerator TestNetworkObjectDespawnOnShutdown()
|
||||
{
|
||||
var useHost = despawnCheck != InstanceType.Server;
|
||||
var networkManager = despawnCheck == InstanceType.Host || despawnCheck == InstanceType.Server ? m_ServerHost : m_Clients[0];
|
||||
|
||||
// Start the instances
|
||||
if (!NetcodeIntegrationTestHelpers.Start(useHost, m_ServerHost, m_Clients))
|
||||
{
|
||||
Debug.LogError("Failed to start instances");
|
||||
Assert.Fail("Failed to start instances");
|
||||
}
|
||||
|
||||
// [Client-Side] Wait for a connection to the server
|
||||
yield return NetcodeIntegrationTestHelpers.WaitForClientsConnected(m_Clients, null, 512);
|
||||
|
||||
// [Host-Server-Side] Check to make sure all clients are connected
|
||||
var clientCount = useHost ? m_Clients.Length + 1 : m_Clients.Length;
|
||||
yield return NetcodeIntegrationTestHelpers.WaitForClientsConnectedToServer(m_ServerHost, clientCount, null, 512);
|
||||
|
||||
// Spawn the test object
|
||||
var spawnedObject = Object.Instantiate(m_NetworkObject);
|
||||
var spawnedObject = SpawnObject(m_ObjectToSpawn, m_ServerNetworkManager);
|
||||
var spawnedNetworkObject = spawnedObject.GetComponent<NetworkObject>();
|
||||
spawnedNetworkObject.NetworkManagerOwner = m_ServerHost;
|
||||
spawnedNetworkObject.Spawn(true);
|
||||
|
||||
// Get the spawned object relative to which NetworkManager instance we are testing.
|
||||
var relativeSpawnedObject = new NetcodeIntegrationTestHelpers.ResultWrapper<NetworkObject>();
|
||||
yield return NetcodeIntegrationTestHelpers.GetNetworkObjectByRepresentation((x => x.GetComponent<OnNetworkDespawnTestComponent>() != null), networkManager, relativeSpawnedObject);
|
||||
var onNetworkDespawnTestComponent = relativeSpawnedObject.Result.GetComponent<OnNetworkDespawnTestComponent>();
|
||||
// Wait for the client to spawn the object
|
||||
yield return WaitForConditionOrTimeOut(() =>
|
||||
{
|
||||
if (!s_GlobalNetworkObjects.ContainsKey(m_ClientNetworkManagers[0].LocalClientId))
|
||||
{
|
||||
return false;
|
||||
}
|
||||
if (!s_GlobalNetworkObjects[m_ClientNetworkManagers[0].LocalClientId].ContainsKey(spawnedNetworkObject.NetworkObjectId))
|
||||
{
|
||||
return false;
|
||||
}
|
||||
return true;
|
||||
});
|
||||
|
||||
AssertOnTimeout($"Timed out waiting for client to spawn {k_ObjectName}!");
|
||||
|
||||
// Confirm it is not set before shutting down the NetworkManager
|
||||
Assert.IsFalse(onNetworkDespawnTestComponent.OnNetworkDespawnCalled);
|
||||
Assert.IsFalse(OnNetworkDespawnTestComponent.OnClientNetworkDespawnCalled, "[Client-side] despawn state is already set (should not be set at this point)!");
|
||||
Assert.IsFalse(OnNetworkDespawnTestComponent.OnServerNetworkDespawnCalled, $"[{m_HostOrServer}-side] despawn state is already set (should not be set at this point)!");
|
||||
|
||||
// Shutdown the NetworkManager instance we are testing.
|
||||
networkManager.Shutdown();
|
||||
// Shutdown the client-side first to validate the client-side instance invokes OnNetworkDespawn
|
||||
m_ClientNetworkManagers[0].Shutdown();
|
||||
yield return WaitForConditionOrTimeOut(() => OnNetworkDespawnTestComponent.OnClientNetworkDespawnCalled);
|
||||
AssertOnTimeout($"[Client-side] Timed out waiting for {k_ObjectName}'s {nameof(NetworkBehaviour.OnNetworkDespawn)} to be invoked!");
|
||||
|
||||
// Since shutdown is now delayed until the post frame update
|
||||
// just wait 2 frames before checking to see if OnNetworkDespawnCalled is true
|
||||
var currentFrame = Time.frameCount + 2;
|
||||
yield return new WaitUntil(() => Time.frameCount <= currentFrame);
|
||||
|
||||
// Confirm that OnNetworkDespawn is invoked after shutdown
|
||||
Assert.IsTrue(onNetworkDespawnTestComponent.OnNetworkDespawnCalled);
|
||||
// Shutdown the servr-host-side second to validate servr-host-side instance invokes OnNetworkDespawn
|
||||
m_ServerNetworkManager.Shutdown();
|
||||
yield return WaitForConditionOrTimeOut(() => OnNetworkDespawnTestComponent.OnClientNetworkDespawnCalled);
|
||||
AssertOnTimeout($"[{m_HostOrServer}-side]Timed out waiting for {k_ObjectName}'s {nameof(NetworkBehaviour.OnNetworkDespawn)} to be invoked!");
|
||||
}
|
||||
}
|
||||
}
|
||||
|
||||
Reference in New Issue
Block a user