Class DisconnectTests

Validates the client disconnection process. This assures that:

  • When a client disconnects from the server that the server: -- Detects the client disconnected. -- Cleans up the transport to NGO client (and vice versa) mappings.
  • When a server disconnects a client that: -- The client detects this disconnection. -- The server cleans up the transport to NGO client (and vice versa) mappings.
  • When DestroyWithOwner the server-side player object is destroyed
  • When DontDestroyWithOwner the server-side player object ownership is transferred back to the server
Inheritance
object
NetcodeIntegrationTest
DisconnectTests
Inherited Members
NetcodeIntegrationTest.s_GlobalTimeoutHelper
NetcodeIntegrationTest.s_DefaultWaitForTick
NetcodeIntegrationTest.NetcodeLogAssert
NetcodeIntegrationTest.s_GlobalNetworkObjects
NetcodeIntegrationTest.RegisterNetworkObject(NetworkObject)
Namespace: Unity.Netcode.RuntimeTests
Assembly: Unity.Netcode.RuntimeTests.dll
Syntax
[TestFixture(new object[] { DisconnectTests.OwnerPersistence.DestroyWithOwner })]
[TestFixture(new object[] { DisconnectTests.OwnerPersistence.DontDestroyWithOwner })]
public class DisconnectTests : NetcodeIntegrationTest

Constructors

DisconnectTests(OwnerPersistence)

Declaration
public DisconnectTests(DisconnectTests.OwnerPersistence ownerPersistence)
Parameters
Type Name Description
DisconnectTests.OwnerPersistence ownerPersistence

Properties

NumberOfClients

Declaration
protected override int NumberOfClients { get; }
Property Value
Type Description
int
Overrides

Methods

ClientPlayerDisconnected(ClientDisconnectType)

Declaration
[UnityTest]
public IEnumerator ClientPlayerDisconnected(DisconnectTests.ClientDisconnectType clientDisconnectType)
Parameters
Type Name Description
DisconnectTests.ClientDisconnectType clientDisconnectType
Returns
Type Description
IEnumerator

OnCreatePlayerPrefab()

Override this to add components or adjustments to the default player prefab m_PlayerPrefab

Declaration
protected override void OnCreatePlayerPrefab()
Overrides

OnServerAndClientsCreated()

This is invoked before the server and client(s) are started. Override this method if you want to make any adjustments to their NetworkManager instances.

Declaration
protected override void OnServerAndClientsCreated()
Overrides

OnSetup()

Called before creating and starting the server and clients Note: For AllTests and PerTest mode integration tests. For those two modes, if you want to have access to the server or client NetworkManagers then override OnServerAndClientsCreated(). m_ServerNetworkManager and m_ClientNetworkManagers

Declaration
protected override IEnumerator OnSetup()
Returns
Type Description
IEnumerator
Overrides

Did you find this page useful? Please give it a rating: