NetworkIdentity identifies objects across the network. More...

Inheritance diagram for Mirror.NetworkIdentity:

Public Member Functions
delegate void	ClientAuthorityCallback (NetworkConnectionToClient conn, NetworkIdentity identity, bool authorityState)
	The delegate type for the clientAuthorityCallback.

bool	AssignClientAuthority (NetworkConnectionToClient conn)
	Assign control of an object to a client via the client's NetworkConnection. More...

void	RemoveClientAuthority ()
	Removes ownership for an object. More...

Static Public Member Functions
static NetworkIdentity	GetSceneIdentity (ulong id)
	Gets the NetworkIdentity from the sceneIds dictionary with the corresponding id

static void	ResetNextNetworkId ()
	Resets nextNetworkId = 1

Public Attributes
Dictionary< int, NetworkConnectionToClient >	observers
	The set of network connections (players) that can see this object. More...

ulong	sceneId
	Unique identifier for NetworkIdentity objects within a scene, used for spawning scene objects. More...

bool	serverOnly
	Make this object only exist when the game is running as a server (or host). More...

Visibility	visible = Visibility.Default

Properties
bool	isClient `[get, set]`
	Returns true if running as a client and this object was spawned by a server. More...

bool	isServer `[get, set]`
	Returns true if NetworkServer.active and server is not stopped. More...

bool	isLocalPlayer `[get, set]`
	Return true if this object represents the player on the local machine. More...

bool	isServerOnly `[get]`
	True if this object only exists on the server More...

bool	isClientOnly `[get]`
	True if this object exists on a client that is not also acting as a server. More...

bool	hasAuthority `[get, set]`
	True on client if that component has been assigned to the client. E.g. player, pets, henchmen. More...

uint	netId `[get, set]`
	The unique network Id of this object (unique at runtime). More...

NetworkConnection	connectionToServer `[get, set]`
	Client's network connection to the server. This is only valid for player objects on the client. More...

NetworkConnectionToClient	connectionToClient `[get, set]`
	Server's network connection to the client. This is only valid for client-owned objects (including the Player object) on the server. More...

static Dictionary< uint, NetworkIdentity >	spawned `[get]`
	All spawned NetworkIdentities by netId. Available on server and client. More...

NetworkBehaviour[]	NetworkBehaviours `[get]`

Guid	assetId `[get, set]`
	Prefab GUID used to spawn prefabs across the network. More...

bool	SpawnedFromInstantiate `[get]`

Events
static ClientAuthorityCallback	clientAuthorityCallback
	A callback that can be populated to be notified when the client-authority state of objects changes. More...

Detailed Description

NetworkIdentity identifies objects across the network.

Definition at line 40 of file NetworkIdentity.cs.

Member Function Documentation

◆ AssignClientAuthority()

bool Mirror.NetworkIdentity.AssignClientAuthority ( NetworkConnectionToClient conn )

Assign control of an object to a client via the client's NetworkConnection.

Definition at line 1172 of file NetworkIdentity.cs.

        {
            if (!isServer)
            {
                Debug.LogError("AssignClientAuthority can only be called on the server for spawned objects.");
                return false;
            }
 
            if (conn == null)
            {
                Debug.LogError($"AssignClientAuthority for {gameObject} owner cannot be null. Use RemoveClientAuthority() instead.");
                return false;
            }
 
            if (connectionToClient != null && conn != connectionToClient)
            {
                Debug.LogError($"AssignClientAuthority for {gameObject} already has an owner. Use RemoveClientAuthority() first.");
                return false;
            }
 
            SetClientOwner(conn);
 
            // The client will match to the existing object
            NetworkServer.SendChangeOwnerMessage(this, conn);
 
            clientAuthorityCallback?.Invoke(conn, this, true);
 
            return true;
        }

◆ RemoveClientAuthority()

void Mirror.NetworkIdentity.RemoveClientAuthority ( )

Removes ownership for an object.

Definition at line 1206 of file NetworkIdentity.cs.

        {
            if (!isServer)
            {
                Debug.LogError("RemoveClientAuthority can only be called on the server for spawned objects.");
                return;
            }
 
            if (connectionToClient?.identity == this)
            {
                Debug.LogError("RemoveClientAuthority cannot remove authority for a player object");
                return;
            }
 
            if (connectionToClient != null)
            {
                clientAuthorityCallback?.Invoke(connectionToClient, this, false);
                NetworkConnectionToClient previousOwner = connectionToClient;
                connectionToClient = null;
                NetworkServer.SendChangeOwnerMessage(this, previousOwner);
            }
        }

Member Data Documentation

◆ observers

Dictionary<int, NetworkConnectionToClient> Mirror.NetworkIdentity.observers

The set of network connections (players) that can see this object.

Definition at line 97 of file NetworkIdentity.cs.

◆ sceneId

ulong Mirror.NetworkIdentity.sceneId

Unique identifier for NetworkIdentity objects within a scene, used for spawning scene objects.

Definition at line 105 of file NetworkIdentity.cs.

◆ serverOnly

bool Mirror.NetworkIdentity.serverOnly

Make this object only exist when the game is running as a server (or host).

Definition at line 110 of file NetworkIdentity.cs.

◆ visible

Visibility Mirror.NetworkIdentity.visible = Visibility.Default

Definition at line 171 of file NetworkIdentity.cs.

Property Documentation

◆ assetId

Guid Mirror.NetworkIdentity.assetId

getset

Prefab GUID used to spawn prefabs across the network.

Definition at line 200 of file NetworkIdentity.cs.

        {
            get
            {
#if UNITY_EDITOR
                // This is important because sometimes OnValidate does not run (like when adding view to prefab with no child links)
                if (string.IsNullOrWhiteSpace(m_AssetId))
                    SetupIDs();
#endif
                // convert string to Guid and use .Empty to avoid exception if
                // we would use 'new Guid("")'
                return string.IsNullOrWhiteSpace(m_AssetId) ? Guid.Empty : new Guid(m_AssetId);
            }
            internal set
            {
                string newAssetIdString = value == Guid.Empty ? string.Empty : value.ToString("N");
                string oldAssetIdString = m_AssetId;
 
                // they are the same, do nothing
                if (oldAssetIdString == newAssetIdString)
                {
                    return;
                }
 
                // new is empty
                if (string.IsNullOrWhiteSpace(newAssetIdString))
                {
                    Debug.LogError($"Can not set AssetId to empty guid on NetworkIdentity '{name}', old assetId '{oldAssetIdString}'");
                    return;
                }
 
                // old not empty
                if (!string.IsNullOrWhiteSpace(oldAssetIdString))
                {
                    Debug.LogError($"Can not Set AssetId on NetworkIdentity '{name}' because it already had an assetId, current assetId '{oldAssetIdString}', attempted new assetId '{newAssetIdString}'");
                    return;
                }
 
                // old is empty
                m_AssetId = newAssetIdString;
                // Debug.Log($"Settings AssetId on NetworkIdentity '{name}', new assetId '{newAssetIdString}'");
            }
        }

◆ connectionToClient

NetworkConnectionToClient Mirror.NetworkIdentity.connectionToClient

getset

Server's network connection to the client. This is only valid for client-owned objects (including the Player object) on the server.

Definition at line 121 of file NetworkIdentity.cs.

        {
            get => _connectionToClient;
            internal set
            {
                _connectionToClient?.RemoveOwnedObject(this);
                _connectionToClient = value;
                _connectionToClient?.AddOwnedObject(this);
            }
        }

◆ connectionToServer

NetworkConnection Mirror.NetworkIdentity.connectionToServer

getset

Client's network connection to the server. This is only valid for player objects on the client.

Definition at line 118 of file NetworkIdentity.cs.

118{ get; internal set; }

◆ hasAuthority

bool Mirror.NetworkIdentity.hasAuthority

getset

True on client if that component has been assigned to the client. E.g. player, pets, henchmen.

Definition at line 92 of file NetworkIdentity.cs.

92{ get; internal set; }

◆ isClient

bool Mirror.NetworkIdentity.isClient

getset

Returns true if running as a client and this object was spawned by a server.

Definition at line 54 of file NetworkIdentity.cs.

54{ get; internal set; }

◆ isClientOnly

bool Mirror.NetworkIdentity.isClientOnly

get

True if this object exists on a client that is not also acting as a server.

Definition at line 89 of file NetworkIdentity.cs.

◆ isLocalPlayer

bool Mirror.NetworkIdentity.isLocalPlayer

getset

Return true if this object represents the player on the local machine.

Definition at line 83 of file NetworkIdentity.cs.

83{ get; internal set; }

◆ isServer

bool Mirror.NetworkIdentity.isServer

getset

Returns true if NetworkServer.active and server is not stopped.

Definition at line 69 of file NetworkIdentity.cs.

69{ get; internal set; }

◆ isServerOnly

bool Mirror.NetworkIdentity.isServerOnly

get

True if this object only exists on the server

Definition at line 86 of file NetworkIdentity.cs.

◆ netId

uint Mirror.NetworkIdentity.netId

getset

The unique network Id of this object (unique at runtime).

Definition at line 100 of file NetworkIdentity.cs.

100{ get; internal set; }

◆ NetworkBehaviours

NetworkBehaviour [] Mirror.NetworkIdentity.NetworkBehaviours

get

Definition at line 160 of file NetworkIdentity.cs.

160{ get; private set; }

◆ spawned

Dictionary<uint, NetworkIdentity> Mirror.NetworkIdentity.spawned

staticget

All spawned NetworkIdentities by netId. Available on server and client.

Definition at line 140 of file NetworkIdentity.cs.

        {
            get
            {
                // server / host mode: use the one from server.
                // host mode has access to all spawned.
                if (NetworkServer.active) return NetworkServer.spawned;
 
                // client
                if (NetworkClient.active) return NetworkClient.spawned;
 
                // neither: then we are testing.
                // we could default to NetworkServer.spawned.
                // but from the outside, that's not obvious.
                // better to throw an exception to make it obvious.
                throw new Exception("NetworkIdentity.spawned was accessed before NetworkServer/NetworkClient were active.");
            }
        }

◆ SpawnedFromInstantiate

bool Mirror.NetworkIdentity.SpawnedFromInstantiate

get

Definition at line 304 of file NetworkIdentity.cs.

304{ get; private set; }

Event Documentation

◆ clientAuthorityCallback

ClientAuthorityCallback Mirror.NetworkIdentity.clientAuthorityCallback

static

A callback that can be populated to be notified when the client-authority state of objects changes.

Definition at line 300 of file NetworkIdentity.cs.

Public Member Functions

Static Public Member Functions

Public Attributes

Properties

Events

Detailed Description

Member Function Documentation

◆ AssignClientAuthority()

◆ RemoveClientAuthority()

Member Data Documentation

◆ observers

◆ sceneId

◆ serverOnly

◆ visible

Property Documentation

◆ assetId

◆ connectionToClient

◆ connectionToServer

◆ hasAuthority

◆ isClient

◆ isClientOnly

◆ isLocalPlayer

◆ isServer

◆ isServerOnly

◆ netId

◆ NetworkBehaviours

◆ spawned

◆ SpawnedFromInstantiate

Event Documentation

◆ clientAuthorityCallback