docs.unity3d.com
    Show / Hide Table of Contents

    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.ToString()
    Object.Equals(Object)
    Object.Equals(Object, Object)
    Object.ReferenceEquals(Object, Object)
    Object.GetHashCode()
    Object.GetType()
    Object.MemberwiseClone()
    Namespace: Unity.Netcode.TestHelpers.Runtime
    Syntax
    public static class NetworkManagerHelper

    Fields

    CurrentNetworkManagerMode

    Declaration
    public static NetworkManagerHelper.NetworkManagerOperatingMode CurrentNetworkManagerMode
    Field Value
    Type Description
    NetworkManagerHelper.NetworkManagerOperatingMode

    InstantiatedGameObjects

    Declaration
    public static Dictionary<Guid, GameObject> InstantiatedGameObjects
    Field Value
    Type Description
    Dictionary<Guid, GameObject>

    InstantiatedNetworkObjects

    Declaration
    public static Dictionary<Guid, NetworkObject> InstantiatedNetworkObjects
    Field Value
    Type Description
    Dictionary<Guid, NetworkObject>

    Properties

    NetworkManagerGameObject

    Declaration
    public static GameObject NetworkManagerGameObject { get; }
    Property Value
    Type Description
    GameObject

    NetworkManagerObject

    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
    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

    BuffersMatch(Int32, Int64, Byte[], Byte[])

    Declaration
    public static bool BuffersMatch(int indexOffset, long targetSize, byte[] sourceArray, byte[] originalArray)
    Parameters
    Type Name Description
    Int32 indexOffset
    Int64 targetSize
    Byte[] sourceArray
    Byte[] originalArray
    Returns
    Type Description
    Boolean

    ShutdownNetworkManager()

    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, NetworkManagerHelper.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 = NetworkManagerHelper.NetworkManagerOperatingMode.Host, NetworkConfig networkConfig = null)
    Parameters
    Type Name Description
    NetworkManager 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
    Boolean

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

    Back to top Copyright © 2023 Unity Technologies — Terms of use
    Generated by DocFX
    on 26 October 2023