Class NetworkManagerHelper

Helper class to instantiate a NetworkManager This also provides the ability to: --- instantiate GameObjects with NetworkObject components that returns a Guid for accessing it later. --- add NetworkBehaviour components to the instantiated GameObjects --- spawn a NetworkObject using its parent GameObject's Guid Call StartNetworkManager in the constructor of your runtime unit test class. Call ShutdownNetworkManager in the destructor of your runtime unit test class.

Includes a useful "BuffersMatch" method that allows you to compare two buffers (returns true if they match false if not)

Inheritance

object

NetworkManagerHelper

Inherited Members

object.Equals(object)

object.Equals(object, object)

object.GetHashCode()

object.GetType()

object.MemberwiseClone()

object.ReferenceEquals(object, object)

object.ToString()

Namespace: Unity.Netcode.TestHelpers.Runtime

Assembly: Unity.Netcode.Runtime.Tests.dll

Syntax

public static class NetworkManagerHelper

Fields

CurrentNetworkManagerMode

The operation mode configured.

Declaration

public static NetworkManagerHelper.NetworkManagerOperatingMode CurrentNetworkManagerMode

Field Value

Type	Description
NetworkManagerHelper.NetworkManagerOperatingMode

InstantiatedGameObjects

All GameObject instances instantiated under the assigned NetworkManager.

Declaration

public static Dictionary<Guid, GameObject> InstantiatedGameObjects

Field Value

Type	Description
Dictionary<Guid, GameObject>

InstantiatedNetworkObjects

All NetworkObject instances instantiated under the assigned NetworkManager.

Declaration

public static Dictionary<Guid, NetworkObject> InstantiatedNetworkObjects

Field Value

Type	Description
Dictionary<Guid, NetworkObject>

Properties

NetworkManagerGameObject

The GameObject of the NetworkManager.

Declaration

public static GameObject NetworkManagerGameObject { get; }

Property Value

Type	Description
GameObject

NetworkManagerObject

The NetworkManager component instantiated.

Declaration

public static NetworkManager NetworkManagerObject { get; }

Property Value

Type	Description
NetworkManager

Methods

AddComponentToObject<T>(Guid)

Helper class to add a component to the GameObject with a NetoworkObject component

Declaration

public static T AddComponentToObject<T>(Guid gameObjectIdentifier) where T : NetworkBehaviour

Parameters

Type	Name	Description
Guid	gameObjectIdentifier	ID returned to reference the game object

Returns

Type	Description
T	The newly added component instance of type T

Type Parameters

Name	Description
T	NetworkBehaviour component being added to the GameObject

AddGameNetworkObject(string)

Add a GameObject with a NetworkObject component

Declaration

public static Guid AddGameNetworkObject(string nameOfGameObject)

Parameters

Type	Name	Description
string	nameOfGameObject	the name of the object

Returns

Type	Description
Guid	A unique identifier, Guid, for the newly created GameObject

BuffersMatch(int, long, byte[], byte[])

Helper method to determine if two buffers match.

Declaration

public static bool BuffersMatch(int indexOffset, long targetSize, byte[] sourceArray, byte[] originalArray)

Parameters

Type	Name	Description
int	indexOffset	Index offset to start from relative to both buffers.
long	targetSize	The number of bytes to compare.
byte[]	sourceArray	The buffer to use for comparison.
byte[]	originalArray	The original buffer being compared.

Returns

Type	Description
bool	true or false

ShutdownNetworkManager()

Invoked even if we assert and exit early from a test, this shuts down the NetworkManager and does some additional clean up.

Declaration

public static void ShutdownNetworkManager()

SpawnNetworkObject(Guid)

Spawn the NetworkObject, so Rpcs can flow

Declaration

public static void SpawnNetworkObject(Guid gameObjectIdentifier)

Parameters

Type	Name	Description
Guid	gameObjectIdentifier	ID returned to reference the game object

StartNetworkManager(out NetworkManager, NetworkManagerOperatingMode, NetworkConfig)

Called upon the RpcQueueTests being instantiated. This creates an instance of the NetworkManager to be used during unit tests. Currently, the best method to run unit tests is by starting in host mode as you can send messages to yourself (i.e. Host-Client to Host-Server and vice versa). As such, the default setting is to start in Host mode.

Declaration

public static bool StartNetworkManager(out NetworkManager networkManager, NetworkManagerHelper.NetworkManagerOperatingMode managerMode = NetworkManagerOperatingMode.Host, NetworkConfig networkConfig = null)

Parameters

Type	Name	Description
NetworkManager	networkManager	The newly started NetworkManager
NetworkManagerHelper.NetworkManagerOperatingMode	managerMode	parameter to specify which mode you want to start the NetworkManager
NetworkConfig	networkConfig	parameter to specify custom NetworkConfig settings

Returns

Type	Description
bool	true if it was instantiated or is already instantiate otherwise false means it failed to instantiate