NetworkClient with connection to server. More...

Static Public Member Functions
static void	Connect (string address)
	Connect client to a NetworkServer by address. More...

static void	Connect (Uri uri)
	Connect client to a NetworkServer by Uri. More...

static void	ConnectHost ()

static void	ConnectLocalServer ()
	Connect host mode More...

static void	Disconnect ()
	Disconnect from server. More...

static void	Send< T > (T message, int channelId=Channels.Reliable)
	Send a NetworkMessage to the server over the given channel. More...

static void	RegisterHandler< T > (Action< T > handler, bool requireAuthentication=true)
	Register a handler for a message type T. Most should require authentication. More...

static void	ReplaceHandler< T > (Action< NetworkConnection, T > handler, bool requireAuthentication=true)
	Replace a handler for a particular message type. Should require authentication by default. More...

static void	ReplaceHandler< T > (Action< T > handler, bool requireAuthentication=true)
	Replace a handler for a particular message type. Should require authentication by default. More...

static bool	UnregisterHandler< T > ()
	Unregister a message handler of type T. More...

static bool	GetPrefab (Guid assetId, out GameObject prefab)
	Find the registered prefab for this asset id. More...

static void	RegisterPrefab (GameObject prefab, Guid newAssetId)
	Register spawnable prefab with custom assetId. More...

static void	RegisterPrefab (GameObject prefab)
	Register spawnable prefab. More...

static void	RegisterPrefab (GameObject prefab, Guid newAssetId, SpawnDelegate spawnHandler, UnSpawnDelegate unspawnHandler)
	Register a spawnable prefab with custom assetId and custom spawn/unspawn handlers. More...

static void	RegisterPrefab (GameObject prefab, SpawnDelegate spawnHandler, UnSpawnDelegate unspawnHandler)
	Register a spawnable prefab with custom spawn/unspawn handlers. More...

static void	RegisterPrefab (GameObject prefab, Guid newAssetId, SpawnHandlerDelegate spawnHandler, UnSpawnDelegate unspawnHandler)
	Register a spawnable prefab with custom assetId and custom spawn/unspawn handlers. More...

static void	RegisterPrefab (GameObject prefab, SpawnHandlerDelegate spawnHandler, UnSpawnDelegate unspawnHandler)
	Register a spawnable prefab with custom spawn/unspawn handlers. More...

static void	UnregisterPrefab (GameObject prefab)
	Removes a registered spawn prefab that was setup with NetworkClient.RegisterPrefab. More...

static void	RegisterSpawnHandler (Guid assetId, SpawnDelegate spawnHandler, UnSpawnDelegate unspawnHandler)
	This is an advanced spawning function that registers a custom assetId with the spawning system. More...

static void	RegisterSpawnHandler (Guid assetId, SpawnHandlerDelegate spawnHandler, UnSpawnDelegate unspawnHandler)
	This is an advanced spawning function that registers a custom assetId with the spawning system. More...

static void	UnregisterSpawnHandler (Guid assetId)
	Removes a registered spawn handler function that was registered with NetworkClient.RegisterHandler(). More...

static void	ClearSpawners ()
	This clears the registered spawn prefabs and spawn handler functions for this client. More...

static bool	Ready ()
	Sends Ready message to server, indicating that we loaded the scene, ready to enter the game. More...

static bool	AddPlayer ()
	Sends AddPlayer message to the server, indicating that we want to join the world. More...

static void	PrepareToSpawnSceneObjects ()
	Call this after loading/unloading a scene in the client after connection to register the spawnable objects More...

static void	DestroyAllClientObjects ()
	Destroys all networked objects on the client. More...

static void	Shutdown ()
	Shutdown the client. More...

Static Public Attributes
static readonly Dictionary< uint, NetworkIdentity >	spawned
	All spawned NetworkIdentities by netId. More...

static bool	ready
	True if client is ready (= joined world). More...

static Action	OnConnectedEvent

static Action	OnDisconnectedEvent

static Action< TransportError, string >	OnErrorEvent

static readonly Dictionary< Guid, GameObject >	prefabs
	Registered spawnable prefabs by assetId. More...

static InterestManagement	aoi

static bool	isLoadingScene

Properties
static NetworkConnection	connection `[get, set]`
	Client's NetworkConnection to server. More...

static NetworkIdentity	localPlayer `[get, set]`
	NetworkIdentity of the localPlayer More...

static string	serverIp `[get]`
	IP address of the connection to server. More...

static bool	active `[get]`
	active is true while a client is connecting/connected More...

static bool	isConnecting `[get]`
	Check if client is connecting (before connected). More...

static bool	isConnected `[get]`
	Check if client is connected (after connecting). More...

static bool	isHostClient `[get]`
	True if client is running in host mode. More...

Detailed Description

NetworkClient with connection to server.

Definition at line 21 of file NetworkClient.cs.

Member Function Documentation

◆ AddPlayer()

static bool Mirror.NetworkClient.AddPlayer ( )

static

Sends AddPlayer message to the server, indicating that we want to join the world.

Definition at line 974 of file NetworkClient.cs.

        {
            // ensure valid ready connection
            if (connection == null)
            {
                Debug.LogError("AddPlayer requires a valid NetworkClient.connection.");
                return false;
            }
 
            // UNET checked 'if readyConnection != null'.
            // in other words, we need a connection and we need to be ready.
            if (!ready)
            {
                Debug.LogError("AddPlayer requires a ready NetworkClient.");
                return false;
            }
 
            if (connection.identity != null)
            {
                Debug.LogError("NetworkClient.AddPlayer: a PlayerController was already added. Did you call AddPlayer twice?");
                return false;
            }
 
            // Debug.Log($"NetworkClient.AddPlayer() called with connection {readyConnection}");
            connection.Send(new AddPlayerMessage());
            return true;
        }

◆ ClearSpawners()

static void Mirror.NetworkClient.ClearSpawners ( )

static

This clears the registered spawn prefabs and spawn handler functions for this client.

Definition at line 900 of file NetworkClient.cs.

        {
            prefabs.Clear();
            spawnHandlers.Clear();
            unspawnHandlers.Clear();
        }

◆ Connect() [1/2]

static void Mirror.NetworkClient.Connect ( string address )

static

Connect client to a NetworkServer by address.

Definition at line 160 of file NetworkClient.cs.

        {
            // Debug.Log($"Client Connect: {address}");
            Debug.Assert(Transport.activeTransport != null, "There was no active transport when calling NetworkClient.Connect, If you are calling Connect manually then make sure to set 'Transport.activeTransport' first");
 
            RegisterSystemHandlers(false);
            Transport.activeTransport.enabled = true;
            AddTransportHandlers();
 
            connectState = ConnectState.Connecting;
            Transport.activeTransport.ClientConnect(address);
 
            connection = new NetworkConnectionToServer();
        }

◆ Connect() [2/2]

static void Mirror.NetworkClient.Connect ( Uri uri )

static

Connect client to a NetworkServer by Uri.

Definition at line 176 of file NetworkClient.cs.

        {
            // Debug.Log($"Client Connect: {uri}");
            Debug.Assert(Transport.activeTransport != null, "There was no active transport when calling NetworkClient.Connect, If you are calling Connect manually then make sure to set 'Transport.activeTransport' first");
 
            RegisterSystemHandlers(false);
            Transport.activeTransport.enabled = true;
            AddTransportHandlers();
 
            connectState = ConnectState.Connecting;
            Transport.activeTransport.ClientConnect(uri);
 
            connection = new NetworkConnectionToServer();
        }

◆ ConnectHost()

static void Mirror.NetworkClient.ConnectHost ( )

static

Definition at line 193 of file NetworkClient.cs.

        {
            //Debug.Log("Client Connect Host to Server");
 
            RegisterSystemHandlers(true);
 
            connectState = ConnectState.Connected;
 
            // create local connection objects and connect them
            LocalConnectionToServer connectionToServer = new LocalConnectionToServer();
            LocalConnectionToClient connectionToClient = new LocalConnectionToClient();
            connectionToServer.connectionToClient = connectionToClient;
            connectionToClient.connectionToServer = connectionToServer;
 
            connection = connectionToServer;
 
            // create server connection to local client
            NetworkServer.SetLocalConnection(connectionToClient);
        }

◆ ConnectLocalServer()

static void Mirror.NetworkClient.ConnectLocalServer ( )

static

Connect host mode

Definition at line 216 of file NetworkClient.cs.

        {
            // call server OnConnected with server's connection to client
            NetworkServer.OnConnected(NetworkServer.localConnection);
 
            // call client OnConnected with client's connection to server
            // => previously we used to send a ConnectMessage to
            //    NetworkServer.localConnection. this would queue the message
            //    until NetworkClient.Update processes it.
            // => invoking the client's OnConnected event directly here makes
            //    tests fail. so let's do it exactly the same order as before by
            //    queueing the event for next Update!
            //OnConnectedEvent?.Invoke(connection);
            ((LocalConnectionToServer)connection).QueueConnectedEvent();
        }

◆ DestroyAllClientObjects()

static void Mirror.NetworkClient.DestroyAllClientObjects ( )

static

Destroys all networked objects on the client.

Definition at line 1444 of file NetworkClient.cs.

        {
            // user can modify spawned lists which causes InvalidOperationException
            // list can modified either in UnSpawnHandler or in OnDisable/OnDestroy
            // we need the Try/Catch so that the rest of the shutdown does not get stopped
            try
            {
                foreach (NetworkIdentity identity in spawned.Values)
                {
                    if (identity != null && identity.gameObject != null)
                    {
                        if (identity.isLocalPlayer)
                            identity.OnStopLocalPlayer();
 
                        identity.OnStopClient();
 
                        // NetworkClient.Shutdown calls DestroyAllClientObjects.
                        // which destroys all objects in NetworkClient.spawned.
                        // => NC.spawned contains owned & observed objects
                        // => in host mode, we CAN NOT destroy observed objects.
                        // => that would destroy them other connection's objects
                        //    on the host server, making them disconnect.
                        // https://github.com/vis2k/Mirror/issues/2954
                        bool hostOwned = identity.connectionToServer is LocalConnectionToServer;
                        bool shouldDestroy = !identity.isServer || hostOwned;
                        if (shouldDestroy)
                        {
                            bool wasUnspawned = InvokeUnSpawnHandler(identity.assetId, identity.gameObject);
 
                            // unspawned objects should be reset for reuse later.
                            if (wasUnspawned)
                            {
                                identity.Reset();
                            }
                            // without unspawn handler, we need to disable/destroy.
                            else
                            {
                                // scene objects are reset and disabled.
                                // they always stay in the scene, we don't destroy them.
                                if (identity.sceneId != 0)
                                {
                                    identity.Reset();
                                    identity.gameObject.SetActive(false);
                                }
                                // spawned objects are destroyed
                                else
                                {
                                    GameObject.Destroy(identity.gameObject);
                                }
                            }
                        }
                    }
                }
                spawned.Clear();
            }
            catch (InvalidOperationException e)
            {
                Debug.LogException(e);
                Debug.LogError("Could not DestroyAllClientObjects because spawned list was modified during loop, make sure you are not modifying NetworkIdentity.spawned by calling NetworkServer.Destroy or NetworkServer.Spawn in OnDestroy or OnDisable.");
            }
        }

◆ Disconnect()

static void Mirror.NetworkClient.Disconnect ( )

static

Disconnect from server.

Definition at line 234 of file NetworkClient.cs.

        {
            // only if connected or connecting.
            // don't disconnect() again if already in the process of
            // disconnecting or fully disconnected.
            if (connectState != ConnectState.Connecting &&
                connectState != ConnectState.Connected)
                return;
 
            // we are disconnecting until OnTransportDisconnected is called.
            // setting state to Disconnected would stop OnTransportDisconnected
            // from calling cleanup code because it would think we are already
            // disconnected fully.
            // TODO move to 'cleanup' code below if safe
            connectState = ConnectState.Disconnecting;
            ready = false;
 
            // call Disconnect on the NetworkConnection
            connection?.Disconnect();
 
            // IMPORTANT: do NOT clear connection here yet.
            // we still need it in OnTransportDisconnected for callbacks.
            // connection = null;
        }

◆ GetPrefab()

static bool Mirror.NetworkClient.GetPrefab	(	Guid	assetId,
		out GameObject	prefab
	)

static

Find the registered prefab for this asset id.

Definition at line 508 of file NetworkClient.cs.

        {
            prefab = null;
            return assetId != Guid.Empty &&
                   prefabs.TryGetValue(assetId, out prefab) && prefab != null;
        }

◆ PrepareToSpawnSceneObjects()

static void Mirror.NetworkClient.PrepareToSpawnSceneObjects ( )

static

Call this after loading/unloading a scene in the client after connection to register the spawnable objects

Definition at line 1158 of file NetworkClient.cs.

        {
            // remove existing items, they will be re-added below
            spawnableObjects.Clear();
 
            // finds all NetworkIdentity currently loaded by unity (includes disabled objects)
            NetworkIdentity[] allIdentities = Resources.FindObjectsOfTypeAll<NetworkIdentity>();
            foreach (NetworkIdentity identity in allIdentities)
            {
                // add all unspawned NetworkIdentities to spawnable objects
                if (ConsiderForSpawning(identity))
                {
                    if (spawnableObjects.TryGetValue(identity.sceneId, out NetworkIdentity existingIdentity))
                    {
                        string msg = $"NetworkClient: Duplicate sceneId {identity.sceneId} detected on {identity.gameObject.name} and {existingIdentity.gameObject.name}\n" +
                            $"This can happen if a networked object is persisted in DontDestroyOnLoad through loading / changing to the scene where it originated,\n" +
                            $"otherwise you may need to open and re-save the {identity.gameObject.scene} to reset scene id's.";
                        Debug.LogWarning(msg, identity.gameObject);
                    }
                    else
                    {
                        spawnableObjects.Add(identity.sceneId, identity);
                    }
                }
            }
        }

◆ Ready()

static bool Mirror.NetworkClient.Ready ( )

static

Sends Ready message to server, indicating that we loaded the scene, ready to enter the game.

Definition at line 923 of file NetworkClient.cs.

        {
            // Debug.Log($"NetworkClient.Ready() called with connection {conn}");
            if (ready)
            {
                Debug.LogError("NetworkClient is already ready. It shouldn't be called twice.");
                return false;
            }
 
            // need a valid connection to become ready
            if (connection == null)
            {
                Debug.LogError("Ready() called with invalid connection object: conn=null");
                return false;
            }
 
            // Set these before sending the ReadyMessage, otherwise host client
            // will fail in InternalAddPlayer with null readyConnection.
            // TODO this is redundant. have one source of truth for .ready
            ready = true;
            connection.isReady = true;
 
            // Tell server we're ready to have a player object spawned
            connection.Send(new ReadyMessage());
            return true;
        }

◆ RegisterHandler< T >()

static void Mirror.NetworkClient.RegisterHandler< T >	(	Action< T >	handler,
		bool	requireAuthentication = `true`
	)

static

Register a handler for a message type T. Most should require authentication.

Type Constraints

T	:	struct
T	:	NetworkMessage

Definition at line 462 of file NetworkClient.cs.

                    : struct, NetworkMessage
        {
            ushort msgType = MessagePacking.GetId<T>();
            if (handlers.ContainsKey(msgType))
            {
                Debug.LogWarning($"NetworkClient.RegisterHandler replacing handler for {typeof(T).FullName}, id={msgType}. If replacement is intentional, use ReplaceHandler instead to avoid this warning.");
            }
            // we use the same WrapHandler function for server and client.
            // so let's wrap it to ignore the NetworkConnection parameter.
            // it's not needed on client. it's always NetworkClient.connection.
            void HandlerWrapped(NetworkConnection _, T value) => handler(value);
            handlers[msgType] = MessagePacking.WrapHandler((Action<NetworkConnection, T>) HandlerWrapped, requireAuthentication);
        }

◆ RegisterPrefab() [1/6]

static void Mirror.NetworkClient.RegisterPrefab ( GameObject prefab )

static

Register spawnable prefab.

Definition at line 589 of file NetworkClient.cs.

        {
            if (prefab == null)
            {
                Debug.LogError("Could not register prefab because it was null");
                return;
            }
 
            NetworkIdentity identity = prefab.GetComponent<NetworkIdentity>();
            if (identity == null)
            {
                Debug.LogError($"Could not register '{prefab.name}' since it contains no NetworkIdentity component");
                return;
            }
 
            RegisterPrefabIdentity(identity);
        }

◆ RegisterPrefab() [2/6]

static void Mirror.NetworkClient.RegisterPrefab	(	GameObject	prefab,
		Guid	newAssetId
	)

static

Register spawnable prefab with custom assetId.

Definition at line 556 of file NetworkClient.cs.

        {
            if (prefab == null)
            {
                Debug.LogError("Could not register prefab because it was null");
                return;
            }
 
            if (newAssetId == Guid.Empty)
            {
                Debug.LogError($"Could not register '{prefab.name}' with new assetId because the new assetId was empty");
                return;
            }
 
            NetworkIdentity identity = prefab.GetComponent<NetworkIdentity>();
            if (identity == null)
            {
                Debug.LogError($"Could not register '{prefab.name}' since it contains no NetworkIdentity component");
                return;
            }
 
            if (identity.assetId != Guid.Empty && identity.assetId != newAssetId)
            {
                Debug.LogError($"Could not register '{prefab.name}' to {newAssetId} because it already had an AssetId, Existing assetId {identity.assetId}");
                return;
            }
 
            identity.assetId = newAssetId;
 
            RegisterPrefabIdentity(identity);
        }

◆ RegisterPrefab() [3/6]

static void Mirror.NetworkClient.RegisterPrefab	(	GameObject	prefab,
		Guid	newAssetId,
		SpawnDelegate	spawnHandler,
		UnSpawnDelegate	unspawnHandler
	)

static

Register a spawnable prefab with custom assetId and custom spawn/unspawn handlers.

Definition at line 612 of file NetworkClient.cs.

        {
            // We need this check here because we don't want a null handler in the lambda expression below
            if (spawnHandler == null)
            {
                Debug.LogError($"Can not Register null SpawnHandler for {newAssetId}");
                return;
            }
 
            RegisterPrefab(prefab, newAssetId, msg => spawnHandler(msg.position, msg.assetId), unspawnHandler);
        }

◆ RegisterPrefab() [4/6]

static void Mirror.NetworkClient.RegisterPrefab	(	GameObject	prefab,
		Guid	newAssetId,
		SpawnHandlerDelegate	spawnHandler,
		UnSpawnDelegate	unspawnHandler
	)

static

Register a spawnable prefab with custom assetId and custom spawn/unspawn handlers.

Definition at line 670 of file NetworkClient.cs.

        {
            if (newAssetId == Guid.Empty)
            {
                Debug.LogError($"Could not register handler for '{prefab.name}' with new assetId because the new assetId was empty");
                return;
            }
 
            if (prefab == null)
            {
                Debug.LogError("Could not register handler for prefab because the prefab was null");
                return;
            }
 
            NetworkIdentity identity = prefab.GetComponent<NetworkIdentity>();
            if (identity == null)
            {
                Debug.LogError($"Could not register handler for '{prefab.name}' since it contains no NetworkIdentity component");
                return;
            }
 
            if (identity.assetId != Guid.Empty && identity.assetId != newAssetId)
            {
                Debug.LogError($"Could not register Handler for '{prefab.name}' to {newAssetId} because it already had an AssetId, Existing assetId {identity.assetId}");
                return;
            }
 
            if (identity.sceneId != 0)
            {
                Debug.LogError($"Can not Register '{prefab.name}' because it has a sceneId, make sure you are passing in the original prefab and not an instance in the scene.");
                return;
            }
 
            identity.assetId = newAssetId;
            Guid assetId = identity.assetId;
 
            if (spawnHandler == null)
            {
                Debug.LogError($"Can not Register null SpawnHandler for {assetId}");
                return;
            }
 
            if (unspawnHandler == null)
            {
                Debug.LogError($"Can not Register null UnSpawnHandler for {assetId}");
                return;
            }
 
            if (spawnHandlers.ContainsKey(assetId) || unspawnHandlers.ContainsKey(assetId))
            {
                Debug.LogWarning($"Replacing existing spawnHandlers for prefab '{prefab.name}' with assetId '{assetId}'");
            }
 
            if (prefabs.ContainsKey(assetId))
            {
                // this is error because SpawnPrefab checks prefabs before handler
                Debug.LogError($"assetId '{assetId}' is already used by prefab '{prefabs[assetId].name}', unregister the prefab first before trying to add handler");
            }
 
            NetworkIdentity[] identities = prefab.GetComponentsInChildren<NetworkIdentity>();
            if (identities.Length > 1)
            {
                Debug.LogError($"Prefab '{prefab.name}' has multiple NetworkIdentity components. There should only be one NetworkIdentity on a prefab, and it must be on the root object.");
            }
 
            //Debug.Log($"Registering custom prefab {prefab.name} as asset:{assetId} {spawnHandler.GetMethodName()}/{unspawnHandler.GetMethodName()}");
 
            spawnHandlers[assetId] = spawnHandler;
            unspawnHandlers[assetId] = unspawnHandler;
        }

◆ RegisterPrefab() [5/6]

static void Mirror.NetworkClient.RegisterPrefab	(	GameObject	prefab,
		SpawnDelegate	spawnHandler,
		UnSpawnDelegate	unspawnHandler
	)

static

Register a spawnable prefab with custom spawn/unspawn handlers.

Definition at line 626 of file NetworkClient.cs.

        {
            if (prefab == null)
            {
                Debug.LogError("Could not register handler for prefab because the prefab was null");
                return;
            }
 
            NetworkIdentity identity = prefab.GetComponent<NetworkIdentity>();
            if (identity == null)
            {
                Debug.LogError($"Could not register handler for '{prefab.name}' since it contains no NetworkIdentity component");
                return;
            }
 
            if (identity.sceneId != 0)
            {
                Debug.LogError($"Can not Register '{prefab.name}' because it has a sceneId, make sure you are passing in the original prefab and not an instance in the scene.");
                return;
            }
 
            Guid assetId = identity.assetId;
 
            if (assetId == Guid.Empty)
            {
                Debug.LogError($"Can not Register handler for '{prefab.name}' because it had empty assetid. If this is a scene Object use RegisterSpawnHandler instead");
                return;
            }
 
            // We need this check here because we don't want a null handler in the lambda expression below
            if (spawnHandler == null)
            {
                Debug.LogError($"Can not Register null SpawnHandler for {assetId}");
                return;
            }
 
            RegisterPrefab(prefab, msg => spawnHandler(msg.position, msg.assetId), unspawnHandler);
        }

◆ RegisterPrefab() [6/6]

static void Mirror.NetworkClient.RegisterPrefab	(	GameObject	prefab,
		SpawnHandlerDelegate	spawnHandler,
		UnSpawnDelegate	unspawnHandler
	)

static

Register a spawnable prefab with custom spawn/unspawn handlers.

Definition at line 743 of file NetworkClient.cs.

        {
            if (prefab == null)
            {
                Debug.LogError("Could not register handler for prefab because the prefab was null");
                return;
            }
 
            NetworkIdentity identity = prefab.GetComponent<NetworkIdentity>();
            if (identity == null)
            {
                Debug.LogError($"Could not register handler for '{prefab.name}' since it contains no NetworkIdentity component");
                return;
            }
 
            if (identity.sceneId != 0)
            {
                Debug.LogError($"Can not Register '{prefab.name}' because it has a sceneId, make sure you are passing in the original prefab and not an instance in the scene.");
                return;
            }
 
            Guid assetId = identity.assetId;
 
            if (assetId == Guid.Empty)
            {
                Debug.LogError($"Can not Register handler for '{prefab.name}' because it had empty assetid. If this is a scene Object use RegisterSpawnHandler instead");
                return;
            }
 
            if (spawnHandler == null)
            {
                Debug.LogError($"Can not Register null SpawnHandler for {assetId}");
                return;
            }
 
            if (unspawnHandler == null)
            {
                Debug.LogError($"Can not Register null UnSpawnHandler for {assetId}");
                return;
            }
 
            if (spawnHandlers.ContainsKey(assetId) || unspawnHandlers.ContainsKey(assetId))
            {
                Debug.LogWarning($"Replacing existing spawnHandlers for prefab '{prefab.name}' with assetId '{assetId}'");
            }
 
            if (prefabs.ContainsKey(assetId))
            {
                // this is error because SpawnPrefab checks prefabs before handler
                Debug.LogError($"assetId '{assetId}' is already used by prefab '{prefabs[assetId].name}', unregister the prefab first before trying to add handler");
            }
 
            NetworkIdentity[] identities = prefab.GetComponentsInChildren<NetworkIdentity>();
            if (identities.Length > 1)
            {
                Debug.LogError($"Prefab '{prefab.name}' has multiple NetworkIdentity components. There should only be one NetworkIdentity on a prefab, and it must be on the root object.");
            }
 
            //Debug.Log($"Registering custom prefab {prefab.name} as asset:{assetId} {spawnHandler.GetMethodName()}/{unspawnHandler.GetMethodName()}");
 
            spawnHandlers[assetId] = spawnHandler;
            unspawnHandlers[assetId] = unspawnHandler;
        }

◆ RegisterSpawnHandler() [1/2]

static void Mirror.NetworkClient.RegisterSpawnHandler	(	Guid	assetId,
		SpawnDelegate	spawnHandler,
		UnSpawnDelegate	unspawnHandler
	)

static

This is an advanced spawning function that registers a custom assetId with the spawning system.

Definition at line 837 of file NetworkClient.cs.

        {
            // We need this check here because we don't want a null handler in the lambda expression below
            if (spawnHandler == null)
            {
                Debug.LogError($"Can not Register null SpawnHandler for {assetId}");
                return;
            }
 
            RegisterSpawnHandler(assetId, msg => spawnHandler(msg.position, msg.assetId), unspawnHandler);
        }

◆ RegisterSpawnHandler() [2/2]

static void Mirror.NetworkClient.RegisterSpawnHandler	(	Guid	assetId,
		SpawnHandlerDelegate	spawnHandler,
		UnSpawnDelegate	unspawnHandler
	)

static

This is an advanced spawning function that registers a custom assetId with the spawning system.

Definition at line 855 of file NetworkClient.cs.

        {
            if (spawnHandler == null)
            {
                Debug.LogError($"Can not Register null SpawnHandler for {assetId}");
                return;
            }
 
            if (unspawnHandler == null)
            {
                Debug.LogError($"Can not Register null UnSpawnHandler for {assetId}");
                return;
            }
 
            if (assetId == Guid.Empty)
            {
                Debug.LogError("Can not Register SpawnHandler for empty Guid");
                return;
            }
 
            if (spawnHandlers.ContainsKey(assetId) || unspawnHandlers.ContainsKey(assetId))
            {
                Debug.LogWarning($"Replacing existing spawnHandlers for {assetId}");
            }
 
            if (prefabs.ContainsKey(assetId))
            {
                // this is error because SpawnPrefab checks prefabs before handler
                Debug.LogError($"assetId '{assetId}' is already used by prefab '{prefabs[assetId].name}'");
            }
 
            // Debug.Log("RegisterSpawnHandler asset {assetId} {spawnHandler.GetMethodName()}/{unspawnHandler.GetMethodName()}");
 
            spawnHandlers[assetId] = spawnHandler;
            unspawnHandlers[assetId] = unspawnHandler;
        }

◆ ReplaceHandler< T >() [1/2]

static void Mirror.NetworkClient.ReplaceHandler< T >	(	Action< NetworkConnection, T >	handler,
		bool	requireAuthentication = `true`
	)

static

Replace a handler for a particular message type. Should require authentication by default.

Type Constraints

T	:	struct
T	:	NetworkMessage

Definition at line 480 of file NetworkClient.cs.

                    : struct, NetworkMessage
        {
            ushort msgType = MessagePacking.GetId<T>();
            handlers[msgType] = MessagePacking.WrapHandler(handler, requireAuthentication);
        }

◆ ReplaceHandler< T >() [2/2]

static void Mirror.NetworkClient.ReplaceHandler< T >	(	Action< T >	handler,
		bool	requireAuthentication = `true`
	)

static

Replace a handler for a particular message type. Should require authentication by default.

Type Constraints

T	:	struct
T	:	NetworkMessage

Definition at line 490 of file NetworkClient.cs.

                    : struct, NetworkMessage
        {
            ReplaceHandler((NetworkConnection _, T value) => { handler(value); }, requireAuthentication);
        }

◆ Send< T >()

static void Mirror.NetworkClient.Send< T >	(	T	message,
		int	channelId = `Channels.Reliable`
	)

static

Send a NetworkMessage to the server over the given channel.

Type Constraints

T	:	struct
T	:	NetworkMessage

Definition at line 446 of file NetworkClient.cs.

                    : struct, NetworkMessage
        {
            if (connection != null)
            {
                if (connectState == ConnectState.Connected)
                {
                    connection.Send(message, channelId);
                }
                else Debug.LogError("NetworkClient Send when not connected to a server");
            }
            else Debug.LogError("NetworkClient Send with no connection");
        }

◆ Shutdown()

static void Mirror.NetworkClient.Shutdown ( )

static

Shutdown the client.

Definition at line 1509 of file NetworkClient.cs.

        {
            //Debug.Log("Shutting down client.");
 
            // calls prefabs.Clear();
            // calls spawnHandlers.Clear();
            // calls unspawnHandlers.Clear();
            ClearSpawners();
 
            // calls spawned.Clear() if no exception occurs
            DestroyAllClientObjects();
 
            spawned.Clear();
            handlers.Clear();
            spawnableObjects.Clear();
 
            // IMPORTANT: do NOT call NetworkIdentity.ResetStatics() here!
            // calling StopClient() in host mode would reset nextNetId to 1,
            // causing next connection to have a duplicate netId accidentally.
            // => see also: https://github.com/vis2k/Mirror/issues/2954
            //NetworkIdentity.ResetStatics();
            // => instead, reset only the client sided statics.
            NetworkIdentity.ResetClientStatics();
 
            // disconnect the client connection.
            // we do NOT call Transport.Shutdown, because someone only called
            // NetworkClient.Shutdown. we can't assume that the server is
            // supposed to be shut down too!
            if (Transport.activeTransport != null)
                Transport.activeTransport.ClientDisconnect();
 
            // reset statics
            connectState = ConnectState.None;
            connection = null;
            localPlayer = null;
            ready = false;
            isSpawnFinished = false;
            isLoadingScene = false;
 
            unbatcher = new Unbatcher();
 
            // clear events. someone might have hooked into them before, but
            // we don't want to use those hooks after Shutdown anymore.
            OnConnectedEvent = null;
            OnDisconnectedEvent = null;
            OnErrorEvent = null;
        }

◆ UnregisterHandler< T >()

static bool Mirror.NetworkClient.UnregisterHandler< T > ( )

static

Unregister a message handler of type T.

Type Constraints

T	:	struct
T	:	NetworkMessage

Definition at line 497 of file NetworkClient.cs.

                    : struct, NetworkMessage
        {
            // use int to minimize collisions
            ushort msgType = MessagePacking.GetId<T>();
            return handlers.Remove(msgType);
        }

◆ UnregisterPrefab()

static void Mirror.NetworkClient.UnregisterPrefab ( GameObject prefab )

static

Removes a registered spawn prefab that was setup with NetworkClient.RegisterPrefab.

Definition at line 808 of file NetworkClient.cs.

        {
            if (prefab == null)
            {
                Debug.LogError("Could not unregister prefab because it was null");
                return;
            }
 
            NetworkIdentity identity = prefab.GetComponent<NetworkIdentity>();
            if (identity == null)
            {
                Debug.LogError($"Could not unregister '{prefab.name}' since it contains no NetworkIdentity component");
                return;
            }
 
            Guid assetId = identity.assetId;
 
            prefabs.Remove(assetId);
            spawnHandlers.Remove(assetId);
            unspawnHandlers.Remove(assetId);
        }

◆ UnregisterSpawnHandler()

static void Mirror.NetworkClient.UnregisterSpawnHandler ( Guid assetId )

static

Removes a registered spawn handler function that was registered with NetworkClient.RegisterHandler().

Definition at line 893 of file NetworkClient.cs.

        {
            spawnHandlers.Remove(assetId);
            unspawnHandlers.Remove(assetId);
        }

Member Data Documentation

◆ aoi

InterestManagement Mirror.NetworkClient.aoi

static

Definition at line 100 of file NetworkClient.cs.

◆ isLoadingScene

bool Mirror.NetworkClient.isLoadingScene

static

Definition at line 103 of file NetworkClient.cs.

◆ OnConnectedEvent

Action Mirror.NetworkClient.OnConnectedEvent

static

Definition at line 72 of file NetworkClient.cs.

◆ OnDisconnectedEvent

Action Mirror.NetworkClient.OnDisconnectedEvent

static

Definition at line 73 of file NetworkClient.cs.

◆ OnErrorEvent

Action<TransportError, string> Mirror.NetworkClient.OnErrorEvent

static

Definition at line 74 of file NetworkClient.cs.

◆ prefabs

readonly Dictionary<Guid, GameObject> Mirror.NetworkClient.prefabs

static

Initial value:

=

new Dictionary<Guid, GameObject>()

Registered spawnable prefabs by assetId.

Definition at line 77 of file NetworkClient.cs.

◆ ready

bool Mirror.NetworkClient.ready

static

True if client is ready (= joined world).

Definition at line 41 of file NetworkClient.cs.

◆ spawned

readonly Dictionary<uint, NetworkIdentity> Mirror.NetworkClient.spawned

static

Initial value:

=

new Dictionary<uint, NetworkIdentity>()

All spawned NetworkIdentities by netId.

Definition at line 29 of file NetworkClient.cs.

Property Documentation

◆ active

bool Mirror.NetworkClient.active

staticget

active is true while a client is connecting/connected

Definition at line 55 of file NetworkClient.cs.

◆ connection

NetworkConnection Mirror.NetworkClient.connection

staticgetset

Client's NetworkConnection to server.

Definition at line 33 of file NetworkClient.cs.

33{ get; internal set; }

◆ isConnected

bool Mirror.NetworkClient.isConnected

staticget

Check if client is connected (after connecting).

Definition at line 62 of file NetworkClient.cs.

◆ isConnecting

bool Mirror.NetworkClient.isConnecting

staticget

Check if client is connecting (before connected).

Definition at line 59 of file NetworkClient.cs.

◆ isHostClient

bool Mirror.NetworkClient.isHostClient

staticget

True if client is running in host mode.

Definition at line 65 of file NetworkClient.cs.

◆ localPlayer

NetworkIdentity Mirror.NetworkClient.localPlayer

staticgetset

NetworkIdentity of the localPlayer

Definition at line 44 of file NetworkClient.cs.

44{ get; internal set; }

◆ serverIp

string Mirror.NetworkClient.serverIp

staticget

IP address of the connection to server.

Definition at line 51 of file NetworkClient.cs.

Static Public Member Functions

Static Public Attributes

Properties

Detailed Description

Member Function Documentation

◆ AddPlayer()

◆ ClearSpawners()

◆ Connect() [1/2]

◆ Connect() [2/2]

◆ ConnectHost()

◆ ConnectLocalServer()

◆ DestroyAllClientObjects()

◆ Disconnect()

◆ GetPrefab()

◆ PrepareToSpawnSceneObjects()

◆ Ready()

◆ RegisterHandler< T >()

◆ RegisterPrefab() [1/6]

◆ RegisterPrefab() [2/6]

◆ RegisterPrefab() [3/6]

◆ RegisterPrefab() [4/6]

◆ RegisterPrefab() [5/6]

◆ RegisterPrefab() [6/6]

◆ RegisterSpawnHandler() [1/2]

◆ RegisterSpawnHandler() [2/2]

◆ ReplaceHandler< T >() [1/2]

◆ ReplaceHandler< T >() [2/2]

◆ Send< T >()

◆ Shutdown()

◆ UnregisterHandler< T >()

◆ UnregisterPrefab()

◆ UnregisterSpawnHandler()

Member Data Documentation

◆ aoi

◆ isLoadingScene

◆ OnConnectedEvent

◆ OnDisconnectedEvent

◆ OnErrorEvent

◆ prefabs

◆ ready

◆ spawned

Property Documentation

◆ active

◆ connection

◆ isConnected

◆ isConnecting

◆ isHostClient

◆ localPlayer

◆ serverIp