Mirror.NetworkBehaviour Class Reference

Base class for networked components. More...

Inheritance diagram for Mirror.NetworkBehaviour:

Classes
struct	NetworkBehaviourSyncVar

Public Member Functions
void	SetSyncVarDirtyBit (ulong dirtyBit)
	Set as dirty so that it's synced to clients again. More...
bool	IsDirty ()
void	ClearAllDirtyBits ()
	Clears all the dirty bits that were set by SetDirtyBits() More...
void	GeneratedSyncVarSetter< T > (T value, ref T field, ulong dirtyBit, Action< T, T > OnChanged)
void	GeneratedSyncVarSetter_GameObject (GameObject value, ref GameObject field, ulong dirtyBit, Action< GameObject, GameObject > OnChanged, ref uint netIdField)
void	GeneratedSyncVarSetter_NetworkIdentity (NetworkIdentity value, ref NetworkIdentity field, ulong dirtyBit, Action< NetworkIdentity, NetworkIdentity > OnChanged, ref uint netIdField)
void	GeneratedSyncVarSetter_NetworkBehaviour< T > (T value, ref T field, ulong dirtyBit, Action< T, T > OnChanged, ref NetworkBehaviourSyncVar netIdField)
void	GeneratedSyncVarDeserialize< T > (ref T field, Action< T, T > OnChanged, T value)
void	GeneratedSyncVarDeserialize_GameObject (ref GameObject field, Action< GameObject, GameObject > OnChanged, NetworkReader reader, ref uint netIdField)
void	GeneratedSyncVarDeserialize_NetworkIdentity (ref NetworkIdentity field, Action< NetworkIdentity, NetworkIdentity > OnChanged, NetworkReader reader, ref uint netIdField)
void	GeneratedSyncVarDeserialize_NetworkBehaviour< T > (ref T field, Action< T, T > OnChanged, NetworkReader reader, ref NetworkBehaviourSyncVar netIdField)
virtual bool	OnSerialize (NetworkWriter writer, bool initialState)
	Override to do custom serialization (instead of SyncVars/SyncLists). Use OnDeserialize too. More...
virtual void	OnDeserialize (NetworkReader reader, bool initialState)
	Override to do custom deserialization (instead of SyncVars/SyncLists). Use OnSerialize too. More...
bool	SerializeObjectsAll (NetworkWriter writer)
bool	SerializeObjectsDelta (NetworkWriter writer)
virtual void	OnStartServer ()
	Like Start(), but only called on server and host. More...
virtual void	OnStopServer ()
	Stop event, only called on server and host. More...
virtual void	OnStartClient ()
	Like Start(), but only called on client and host. More...
virtual void	OnStopClient ()
	Stop event, only called on client and host. More...
virtual void	OnStartLocalPlayer ()
	Like Start(), but only called on client and host for the local player object. More...
virtual void	OnStopLocalPlayer ()
	Stop event, but only called on client and host for the local player object. More...
virtual void	OnStartAuthority ()
	Like Start(), but only called for objects the client has authority over. More...
virtual void	OnStopAuthority ()
	Stop event, only called for objects the client has authority over. More...

Static Public Member Functions
static bool	SyncVarGameObjectEqual (GameObject newGameObject, uint netIdField)
static bool	SyncVarNetworkIdentityEqual (NetworkIdentity newIdentity, uint netIdField)

Public Attributes
SyncMode	syncMode = SyncMode.Observers
	sync mode for OnSerialize More...
float	syncInterval = 0.1f
	sync interval for OnSerialize (in seconds) More...

Protected Member Functions
bool	GetSyncVarHookGuard (ulong dirtyBit)
void	SetSyncVarHookGuard (ulong dirtyBit, bool value)
void	InitSyncObject (SyncObject syncObject)
void	SendCommandInternal (string functionFullName, NetworkWriter writer, int channelId, bool requiresAuthority=true)
void	SendRPCInternal (string functionFullName, NetworkWriter writer, int channelId, bool includeOwner)
void	SendTargetRPCInternal (NetworkConnection conn, string functionFullName, NetworkWriter writer, int channelId)
void	SetSyncVarGameObject (GameObject newGameObject, ref GameObject gameObjectField, ulong dirtyBit, ref uint netIdField)
GameObject	GetSyncVarGameObject (uint netId, ref GameObject gameObjectField)
void	SetSyncVarNetworkIdentity (NetworkIdentity newIdentity, ref NetworkIdentity identityField, ulong dirtyBit, ref uint netIdField)
NetworkIdentity	GetSyncVarNetworkIdentity (uint netId, ref NetworkIdentity identityField)
void	SetSyncVarNetworkBehaviour< T > (T newBehaviour, ref T behaviourField, ulong dirtyBit, ref NetworkBehaviourSyncVar syncField)
T	GetSyncVarNetworkBehaviour< T > (NetworkBehaviourSyncVar syncNetBehaviour, ref T behaviourField)
void	SetSyncVar< T > (T value, ref T fieldValue, ulong dirtyBit)
virtual bool	SerializeSyncVars (NetworkWriter writer, bool initialState)
virtual void	DeserializeSyncVars (NetworkReader reader, bool initialState)

Static Protected Member Functions
static bool	SyncVarNetworkBehaviourEqual< T > (T newBehaviour, NetworkBehaviourSyncVar syncField)
static bool	SyncVarEqual< T > (T value, ref T fieldValue)

Protected Attributes
readonly List< SyncObject >	syncObjects = new List<SyncObject>()

Properties
bool	isServer [get]
	True if this object is on the server and has been spawned. More...
bool	isClient [get]
	True if this object is on the client and has been spawned by the server. More...
bool	isLocalPlayer [get]
	True if this object is the the client's own local player. More...
bool	isServerOnly [get]
	True if this object is on the server-only, not host. More...
bool	isClientOnly [get]
	True if this object is on the client-only, not host. More...
bool	hasAuthority [get]
	True on client if that component has been assigned to the client. E.g. player, pets, henchmen. More...
uint	netId [get]
	The unique network Id of this object (unique at runtime). More...
NetworkConnection	connectionToServer [get]
	Client's network connection to the server. This is only valid for player objects on the client. More...
NetworkConnectionToClient	connectionToClient [get]
	Server's network connection to the client. This is only valid for player objects on the server. More...
NetworkIdentity	netIdentity [get, set]
	Returns the NetworkIdentity of this object More...
int	ComponentIndex [get, set]
	Returns the index of the component on this object More...
ulong	syncVarDirtyBits [get]

Detailed Description

Base class for networked components.

Definition at line 15 of file NetworkBehaviour.cs.

Member Function Documentation

ClearAllDirtyBits()

void Mirror.NetworkBehaviour.ClearAllDirtyBits

(

)

Clears all the dirty bits that were set by SetDirtyBits()

Definition at line 137 of file NetworkBehaviour.cs.

        {
            lastSyncTime = NetworkTime.localTime;
            syncVarDirtyBits = 0L;
            syncObjectDirtyBits = 0L;
 
            // clear all unsynchronized changes in syncobjects
            // (Linq allocates, use for instead)
            for (int i = 0; i < syncObjects.Count; ++i)
            {
                syncObjects[i].ClearChanges();
            }
        }

DeserializeSyncVars()

virtual void Mirror.NetworkBehaviour.DeserializeSyncVars ( NetworkReader  reader, bool  initialState  )

protectedvirtual

Definition at line 985 of file NetworkBehaviour.cs.

        {
            // SyncVars are read here in subclass
 
            // if initialState
            //   read all SyncVars
            // else
            //   read syncVarDirtyBits
            //   read dirty SyncVars
        }

GeneratedSyncVarDeserialize< T >()

void Mirror.NetworkBehaviour.GeneratedSyncVarDeserialize< T >	(	ref T	field,
		Action< T, T >	OnChanged,
		T	value
	)

Definition at line 584 of file NetworkBehaviour.cs.

        {
            T previous = field;
            field = value;
 
            // any hook? then call if changed.
            if (OnChanged != null && !SyncVarEqual(previous, ref field))
            {
                OnChanged(previous, field);
            }
        }

GeneratedSyncVarDeserialize_GameObject()

void Mirror.NetworkBehaviour.GeneratedSyncVarDeserialize_GameObject	(	ref GameObject	field,
		Action< GameObject, GameObject >	OnChanged,
		NetworkReader	reader,
		ref uint	netIdField
	)

Definition at line 642 of file NetworkBehaviour.cs.

        {
            uint previousNetId = netIdField;
            GameObject previousGameObject = field;
            netIdField = reader.ReadUInt();
 
            // get the new GameObject now that netId field is set
            field = GetSyncVarGameObject(netIdField, ref field);
 
            // any hook? then call if changed.
            if (OnChanged != null && !SyncVarEqual(previousNetId, ref netIdField))
            {
                OnChanged(previousGameObject, field);
            }
        }

GeneratedSyncVarDeserialize_NetworkBehaviour< T >()

void Mirror.NetworkBehaviour.GeneratedSyncVarDeserialize_NetworkBehaviour< T >	(	ref T	field,
		Action< T, T >	OnChanged,
		NetworkReader	reader,
		ref NetworkBehaviourSyncVar	netIdField
	)

Type Constraints

T

:

NetworkBehaviour

Definition at line 769 of file NetworkBehaviour.cs.

                    : NetworkBehaviour
        {
            NetworkBehaviourSyncVar previousNetId = netIdField;
            T previousBehaviour = field;
            netIdField = reader.ReadNetworkBehaviourSyncVar();
 
            // get the new NetworkBehaviour now that netId field is set
            field = GetSyncVarNetworkBehaviour(netIdField, ref field);
 
            // any hook? then call if changed.
            if (OnChanged != null && !SyncVarEqual(previousNetId, ref netIdField))
            {
                OnChanged(previousBehaviour, field);
            }
        }

GeneratedSyncVarDeserialize_NetworkIdentity()

void Mirror.NetworkBehaviour.GeneratedSyncVarDeserialize_NetworkIdentity	(	ref NetworkIdentity	field,
		Action< NetworkIdentity, NetworkIdentity >	OnChanged,
		NetworkReader	reader,
		ref uint	netIdField
	)

Definition at line 705 of file NetworkBehaviour.cs.

        {
            uint previousNetId = netIdField;
            NetworkIdentity previousIdentity = field;
            netIdField = reader.ReadUInt();
 
            // get the new NetworkIdentity now that netId field is set
            field = GetSyncVarNetworkIdentity(netIdField, ref field);
 
            // any hook? then call if changed.
            if (OnChanged != null && !SyncVarEqual(previousNetId, ref netIdField))
            {
                OnChanged(previousIdentity, field);
            }
        }

GeneratedSyncVarSetter< T >()

void Mirror.NetworkBehaviour.GeneratedSyncVarSetter< T >	(	T	value,
		ref T	field,
		ulong	dirtyBit,
		Action< T, T >	OnChanged
	)

Definition at line 345 of file NetworkBehaviour.cs.

        {
            if (!SyncVarEqual(value, ref field))
            {
                T oldValue = field;
                SetSyncVar(value, ref field, dirtyBit);
 
                // call hook (if any)
                if (OnChanged != null)
                {
                    // in host mode, setting a SyncVar calls the hook directly.
                    // in client-only mode, OnDeserialize would call it.
                    // we use hook guard to protect against deadlock where hook
                    // changes syncvar, calling hook again.
                    if (NetworkServer.localClientActive && !GetSyncVarHookGuard(dirtyBit))
                    {
                        SetSyncVarHookGuard(dirtyBit, true);
                        OnChanged(oldValue, value);
                        SetSyncVarHookGuard(dirtyBit, false);
                    }
                }
            }
        }

GeneratedSyncVarSetter_GameObject()

void Mirror.NetworkBehaviour.GeneratedSyncVarSetter_GameObject	(	GameObject	value,
		ref GameObject	field,
		ulong	dirtyBit,
		Action< GameObject, GameObject >	OnChanged,
		ref uint	netIdField
	)

Definition at line 372 of file NetworkBehaviour.cs.

        {
            if (!SyncVarGameObjectEqual(value, netIdField))
            {
                GameObject oldValue = field;
                SetSyncVarGameObject(value, ref field, dirtyBit, ref netIdField);
 
                // call hook (if any)
                if (OnChanged != null)
                {
                    // in host mode, setting a SyncVar calls the hook directly.
                    // in client-only mode, OnDeserialize would call it.
                    // we use hook guard to protect against deadlock where hook
                    // changes syncvar, calling hook again.
                    if (NetworkServer.localClientActive && !GetSyncVarHookGuard(dirtyBit))
                    {
                        SetSyncVarHookGuard(dirtyBit, true);
                        OnChanged(oldValue, value);
                        SetSyncVarHookGuard(dirtyBit, false);
                    }
                }
            }
        }

GeneratedSyncVarSetter_NetworkBehaviour< T >()

void Mirror.NetworkBehaviour.GeneratedSyncVarSetter_NetworkBehaviour< T >	(	T	value,
		ref T	field,
		ulong	dirtyBit,
		Action< T, T >	OnChanged,
		ref NetworkBehaviourSyncVar	netIdField
	)

Type Constraints

T

:

NetworkBehaviour

Definition at line 426 of file NetworkBehaviour.cs.

                    : NetworkBehaviour
        {
            if (!SyncVarNetworkBehaviourEqual(value, netIdField))
            {
                T oldValue = field;
                SetSyncVarNetworkBehaviour(value, ref field, dirtyBit, ref netIdField);
 
                // call hook (if any)
                if (OnChanged != null)
                {
                    // in host mode, setting a SyncVar calls the hook directly.
                    // in client-only mode, OnDeserialize would call it.
                    // we use hook guard to protect against deadlock where hook
                    // changes syncvar, calling hook again.
                    if (NetworkServer.localClientActive && !GetSyncVarHookGuard(dirtyBit))
                    {
                        SetSyncVarHookGuard(dirtyBit, true);
                        OnChanged(oldValue, value);
                        SetSyncVarHookGuard(dirtyBit, false);
                    }
                }
            }
        }

GeneratedSyncVarSetter_NetworkIdentity()

void Mirror.NetworkBehaviour.GeneratedSyncVarSetter_NetworkIdentity	(	NetworkIdentity	value,
		ref NetworkIdentity	field,
		ulong	dirtyBit,
		Action< NetworkIdentity, NetworkIdentity >	OnChanged,
		ref uint	netIdField
	)

Definition at line 399 of file NetworkBehaviour.cs.

        {
            if (!SyncVarNetworkIdentityEqual(value, netIdField))
            {
                NetworkIdentity oldValue = field;
                SetSyncVarNetworkIdentity(value, ref field, dirtyBit, ref netIdField);
 
                // call hook (if any)
                if (OnChanged != null)
                {
                    // in host mode, setting a SyncVar calls the hook directly.
                    // in client-only mode, OnDeserialize would call it.
                    // we use hook guard to protect against deadlock where hook
                    // changes syncvar, calling hook again.
                    if (NetworkServer.localClientActive && !GetSyncVarHookGuard(dirtyBit))
                    {
                        SetSyncVarHookGuard(dirtyBit, true);
                        OnChanged(oldValue, value);
                        SetSyncVarHookGuard(dirtyBit, false);
                    }
                }
            }
        }

GetSyncVarGameObject()

GameObject Mirror.NetworkBehaviour.GetSyncVarGameObject ( uint  netId, ref GameObject  gameObjectField  )

protected

Definition at line 504 of file NetworkBehaviour.cs.

        {
            // server always uses the field
            if (isServer)
            {
                return gameObjectField;
            }
 
            // client always looks up based on netId because objects might get in and out of range
            // over and over again, which shouldn't null them forever
            if (NetworkClient.spawned.TryGetValue(netId, out NetworkIdentity identity) && identity != null)
                return gameObjectField = identity.gameObject;
            return null;
        }

GetSyncVarNetworkBehaviour< T >()

T Mirror.NetworkBehaviour.GetSyncVarNetworkBehaviour< T > ( NetworkBehaviourSyncVar  syncNetBehaviour, ref T  behaviourField  )

protected

Type Constraints

T

:

NetworkBehaviour

Definition at line 875 of file NetworkBehaviour.cs.

                                                                                                                          : NetworkBehaviour
        {
            // server always uses the field
            if (isServer)
            {
                return behaviourField;
            }
 
            // client always looks up based on netId because objects might get in and out of range
            // over and over again, which shouldn't null them forever
            if (!NetworkClient.spawned.TryGetValue(syncNetBehaviour.netId, out NetworkIdentity identity))
            {
                return null;
            }
 
            behaviourField = identity.NetworkBehaviours[syncNetBehaviour.componentIndex] as T;
            return behaviourField;
        }

GetSyncVarNetworkIdentity()

NetworkIdentity Mirror.NetworkBehaviour.GetSyncVarNetworkIdentity ( uint  netId, ref NetworkIdentity  identityField  )

protected

Definition at line 812 of file NetworkBehaviour.cs.

        {
            // server always uses the field
            if (isServer)
            {
                return identityField;
            }
 
            // client always looks up based on netId because objects might get in and out of range
            // over and over again, which shouldn't null them forever
            NetworkClient.spawned.TryGetValue(netId, out identityField);
            return identityField;
        }

InitSyncObject()

void Mirror.NetworkBehaviour.InitSyncObject ( SyncObject  syncObject )

protected

Definition at line 154 of file NetworkBehaviour.cs.

        {
            if (syncObject == null)
            {
                Debug.LogError("Uninitialized SyncObject. Manually call the constructor on your SyncList, SyncSet, SyncDictionary or SyncField<T>");
                return;
            }
 
            // add it, remember the index in list (if Count=0, index=0 etc.)
            int index = syncObjects.Count;
            syncObjects.Add(syncObject);
 
            // OnDirty needs to set nth bit in our dirty mask
            ulong nthBit = 1UL << index;
            syncObject.OnDirty = () => syncObjectDirtyBits |= nthBit;
 
            // only record changes while we have observers.
            // prevents ever growing .changes lists:
            //   if a monster has no observers but we keep modifing a SyncObject,
            //   then the changes would never be flushed and keep growing,
            //   because OnSerialize isn't called without observers.
            syncObject.IsRecording = () => netIdentity.observers?.Count > 0;
        }

IsDirty()

bool Mirror.NetworkBehaviour.IsDirty

(

)

Definition at line 124 of file NetworkBehaviour.cs.

        {
            if (NetworkTime.localTime - lastSyncTime >= syncInterval)
            {
                // OR both bitmasks. != 0 if either was dirty.
                return (syncVarDirtyBits | syncObjectDirtyBits) != 0UL;
            }
            return false;
        }

OnDeserialize()

virtual void Mirror.NetworkBehaviour.OnDeserialize ( NetworkReader  reader, bool  initialState  )

virtual

Override to do custom deserialization (instead of SyncVars/SyncLists). Use OnSerialize too.

Definition at line 956 of file NetworkBehaviour.cs.

        {
            if (initialState)
            {
                DeSerializeObjectsAll(reader);
            }
            else
            {
                DeSerializeObjectsDelta(reader);
            }
 
            DeserializeSyncVars(reader, initialState);
        }

OnSerialize()

virtual bool Mirror.NetworkBehaviour.OnSerialize ( NetworkWriter  writer, bool  initialState  )

virtual

Override to do custom serialization (instead of SyncVars/SyncLists). Use OnDeserialize too.

Definition at line 946 of file NetworkBehaviour.cs.

        {
            // if initialState: write all SyncVars.
            // otherwise write dirtyBits+dirty SyncVars
            bool objectWritten = initialState ? SerializeObjectsAll(writer) : SerializeObjectsDelta(writer);
            bool syncVarWritten = SerializeSyncVars(writer, initialState);
            return objectWritten || syncVarWritten;
        }

OnStartAuthority()

virtual void Mirror.NetworkBehaviour.OnStartAuthority ( )

virtual

Like Start(), but only called for objects the client has authority over.

Definition at line 1077 of file NetworkBehaviour.cs.

{}

OnStartClient()

virtual void Mirror.NetworkBehaviour.OnStartClient ( )

virtual

Like Start(), but only called on client and host.

Definition at line 1065 of file NetworkBehaviour.cs.

{}

OnStartLocalPlayer()

virtual void Mirror.NetworkBehaviour.OnStartLocalPlayer ( )

virtual

Like Start(), but only called on client and host for the local player object.

Definition at line 1071 of file NetworkBehaviour.cs.

{}

OnStartServer()

virtual void Mirror.NetworkBehaviour.OnStartServer ( )

virtual

Like Start(), but only called on server and host.

Definition at line 1059 of file NetworkBehaviour.cs.

{}

OnStopAuthority()

virtual void Mirror.NetworkBehaviour.OnStopAuthority ( )

virtual

Stop event, only called for objects the client has authority over.

Definition at line 1080 of file NetworkBehaviour.cs.

{}

OnStopClient()

virtual void Mirror.NetworkBehaviour.OnStopClient ( )

virtual

Stop event, only called on client and host.

Definition at line 1068 of file NetworkBehaviour.cs.

{}

OnStopLocalPlayer()

virtual void Mirror.NetworkBehaviour.OnStopLocalPlayer ( )

virtual

Stop event, but only called on client and host for the local player object.

Definition at line 1074 of file NetworkBehaviour.cs.

{}

OnStopServer()

virtual void Mirror.NetworkBehaviour.OnStopServer ( )

virtual

Stop event, only called on server and host.

Definition at line 1062 of file NetworkBehaviour.cs.

{}

SendCommandInternal()

void Mirror.NetworkBehaviour.SendCommandInternal ( string  functionFullName, NetworkWriter  writer, int  channelId, bool  requiresAuthority = true  )

protected

Definition at line 179 of file NetworkBehaviour.cs.

        {
            // this was in Weaver before
            // NOTE: we could remove this later to allow calling Cmds on Server
            //       to avoid Wrapper functions. a lot of people requested this.
            if (!NetworkClient.active)
            {
                Debug.LogError($"Command Function {functionFullName} called on {name} without an active client.", gameObject);
                return;
            }
 
            // previously we used NetworkClient.readyConnection.
            // now we check .ready separately.
            if (!NetworkClient.ready)
            {
                // Unreliable Cmds from NetworkTransform may be generated,
                // or client may have been set NotReady intentionally, so
                // only warn if on the reliable channel.
                if (channelId == Channels.Reliable)
                    Debug.LogWarning($"Command Function {functionFullName} called on {name} while NetworkClient is not ready.\nThis may be ignored if client intentionally set NotReady.", gameObject);
                return;
            }
 
            // local players can always send commands, regardless of authority, other objects must have authority.
            if (!(!requiresAuthority || isLocalPlayer || hasAuthority))
            {
                Debug.LogWarning($"Command Function {functionFullName} called on {name} without authority.", gameObject);
                return;
            }
 
            // IMPORTANT: can't use .connectionToServer here because calling
            // a command on other objects is allowed if requireAuthority is
            // false. other objects don't have a .connectionToServer.
            // => so we always need to use NetworkClient.connection instead.
            // => see also: https://github.com/vis2k/Mirror/issues/2629
            if (NetworkClient.connection == null)
            {
                Debug.LogError($"Command Function {functionFullName} called on {name} with no client running.", gameObject);
                return;
            }
 
            // construct the message
            CommandMessage message = new CommandMessage
            {
                netId = netId,
                componentIndex = (byte)ComponentIndex,
                // type+func so Inventory.RpcUse != Equipment.RpcUse
                functionHash = (ushort)functionFullName.GetStableHashCode(),
                // segment to avoid reader allocations
                payload = writer.ToArraySegment()
            };
 
            // IMPORTANT: can't use .connectionToServer here because calling
            // a command on other objects is allowed if requireAuthority is
            // false. other objects don't have a .connectionToServer.
            // => so we always need to use NetworkClient.connection instead.
            // => see also: https://github.com/vis2k/Mirror/issues/2629
            NetworkClient.connection.Send(message, channelId);
        }

SendRPCInternal()

void Mirror.NetworkBehaviour.SendRPCInternal ( string  functionFullName, NetworkWriter  writer, int  channelId, bool  includeOwner  )

protected

Definition at line 240 of file NetworkBehaviour.cs.

        {
            // this was in Weaver before
            if (!NetworkServer.active)
            {
                Debug.LogError($"RPC Function {functionFullName} called on Client.", gameObject);
                return;
            }
 
            // This cannot use NetworkServer.active, as that is not specific to this object.
            if (!isServer)
            {
                Debug.LogWarning($"ClientRpc {functionFullName} called on un-spawned object: {name}", gameObject);
                return;
            }
 
            // construct the message
            RpcMessage message = new RpcMessage
            {
                netId = netId,
                componentIndex = (byte)ComponentIndex,
                // type+func so Inventory.RpcUse != Equipment.RpcUse
                functionHash = (ushort)functionFullName.GetStableHashCode(),
                // segment to avoid reader allocations
                payload = writer.ToArraySegment()
            };
 
            NetworkServer.SendToReadyObservers(netIdentity, message, includeOwner, channelId);
        }

SendTargetRPCInternal()

void Mirror.NetworkBehaviour.SendTargetRPCInternal ( NetworkConnection  conn, string  functionFullName, NetworkWriter  writer, int  channelId  )

protected

Definition at line 271 of file NetworkBehaviour.cs.

        {
            if (!NetworkServer.active)
            {
                Debug.LogError($"TargetRPC {functionFullName} called on {name} when server not active", gameObject);
                return;
            }
 
            if (!isServer)
            {
                Debug.LogWarning($"TargetRpc {functionFullName} called on {name} but that object has not been spawned or has been unspawned", gameObject);
                return;
            }
 
            // connection parameter is optional. assign if null.
            if (conn is null)
            {
                conn = connectionToClient;
            }
 
            // if still null
            if (conn is null)
            {
                Debug.LogError($"TargetRPC {functionFullName} was given a null connection, make sure the object {name} has an owner or you pass in the target connection", gameObject);
                return;
            }
 
            if (!(conn is NetworkConnectionToClient))
            {
                Debug.LogError($"TargetRPC {functionFullName} called on {name} requires a NetworkConnectionToClient but was given {conn.GetType().Name}", gameObject);
                return;
            }
 
            // construct the message
            RpcMessage message = new RpcMessage
            {
                netId = netId,
                componentIndex = (byte)ComponentIndex,
                // type+func so Inventory.RpcUse != Equipment.RpcUse
                functionHash = (ushort)functionFullName.GetStableHashCode(),
                // segment to avoid reader allocations
                payload = writer.ToArraySegment()
            };
 
            conn.Send(message, channelId);
        }

SerializeObjectsAll()

bool Mirror.NetworkBehaviour.SerializeObjectsAll

(

NetworkWriter

writer

)

Definition at line 996 of file NetworkBehaviour.cs.

        {
            bool dirty = false;
            for (int i = 0; i < syncObjects.Count; i++)
            {
                SyncObject syncObject = syncObjects[i];
                syncObject.OnSerializeAll(writer);
                dirty = true;
            }
            return dirty;
        }

SerializeObjectsDelta()

bool Mirror.NetworkBehaviour.SerializeObjectsDelta

(

NetworkWriter

writer

)

Definition at line 1008 of file NetworkBehaviour.cs.

        {
            bool dirty = false;
            // write the mask
            writer.WriteULong(syncObjectDirtyBits);
            // serializable objects, such as synclists
            for (int i = 0; i < syncObjects.Count; i++)
            {
                // check dirty mask at nth bit
                SyncObject syncObject = syncObjects[i];
                if ((syncObjectDirtyBits & (1UL << i)) != 0)
                {
                    syncObject.OnSerializeDelta(writer);
                    dirty = true;
                }
            }
            return dirty;
        }

SerializeSyncVars()

virtual bool Mirror.NetworkBehaviour.SerializeSyncVars ( NetworkWriter  writer, bool  initialState  )

protectedvirtual

Definition at line 971 of file NetworkBehaviour.cs.

        {
            return false;
 
            // SyncVar are written here in subclass
 
            // if initialState
            //   write all SyncVars
            // else
            //   write syncVarDirtyBits
            //   write dirty SyncVars
        }

SetSyncVar< T >()

void Mirror.NetworkBehaviour.SetSyncVar< T > ( T  value, ref T  fieldValue, ulong  dirtyBit  )

protected

Definition at line 933 of file NetworkBehaviour.cs.

        {
            //Debug.Log($"SetSyncVar {GetType().Name} bit:{dirtyBit} fieldValue:{value}");
            SetSyncVarDirtyBit(dirtyBit);
            fieldValue = value;
        }

SetSyncVarDirtyBit()

void Mirror.NetworkBehaviour.SetSyncVarDirtyBit

(

ulong

dirtyBit

)

Set as dirty so that it's synced to clients again.

Definition at line 118 of file NetworkBehaviour.cs.

        {
            syncVarDirtyBits |= dirtyBit;
        }

SetSyncVarGameObject()

void Mirror.NetworkBehaviour.SetSyncVarGameObject ( GameObject  newGameObject, ref GameObject  gameObjectField, ulong  dirtyBit, ref uint  netIdField  )

protected

Definition at line 476 of file NetworkBehaviour.cs.

        {
            if (GetSyncVarHookGuard(dirtyBit))
                return;
 
            uint newNetId = 0;
            if (newGameObject != null)
            {
                NetworkIdentity identity = newGameObject.GetComponent<NetworkIdentity>();
                if (identity != null)
                {
                    newNetId = identity.netId;
                    if (newNetId == 0)
                    {
                        Debug.LogWarning($"SetSyncVarGameObject GameObject {newGameObject} has a zero netId. Maybe it is not spawned yet?");
                    }
                }
            }
 
            //Debug.Log($"SetSyncVar GameObject {GetType().Name} bit:{dirtyBit} netfieldId:{netIdField} -> {newNetId}");
            SetSyncVarDirtyBit(dirtyBit);
            // assign new one on the server, and in case we ever need it on client too
            gameObjectField = newGameObject;
            netIdField = newNetId;
        }

SetSyncVarHookGuard()

void Mirror.NetworkBehaviour.SetSyncVarHookGuard ( ulong  dirtyBit, bool  value  )

protected

Definition at line 106 of file NetworkBehaviour.cs.

        {
            // set the bit
            if (value)
                syncVarHookGuard |= dirtyBit;
            // clear the bit
            else
                syncVarHookGuard &= ~dirtyBit;
        }

SetSyncVarNetworkBehaviour< T >()

void Mirror.NetworkBehaviour.SetSyncVarNetworkBehaviour< T > ( T  newBehaviour, ref T  behaviourField, ulong  dirtyBit, ref NetworkBehaviourSyncVar  syncField  )

protected

Type Constraints

T

:

NetworkBehaviour

Definition at line 846 of file NetworkBehaviour.cs.

                                                                                                                                                          : NetworkBehaviour
        {
            if (GetSyncVarHookGuard(dirtyBit))
                return;
 
            uint newNetId = 0;
            int componentIndex = 0;
            if (newBehaviour != null)
            {
                newNetId = newBehaviour.netId;
                componentIndex = newBehaviour.ComponentIndex;
                if (newNetId == 0)
                {
                    Debug.LogWarning($"{nameof(SetSyncVarNetworkBehaviour)} NetworkIdentity {newBehaviour} has a zero netId. Maybe it is not spawned yet?");
                }
            }
 
            syncField = new NetworkBehaviourSyncVar(newNetId, componentIndex);
 
            SetSyncVarDirtyBit(dirtyBit);
 
            // assign new one on the server, and in case we ever need it on client too
            behaviourField = newBehaviour;
 
            // Debug.Log($"SetSyncVarNetworkBehaviour NetworkIdentity {GetType().Name} bit [{dirtyBit}] netIdField:{oldField}->{syncField}");
        }

SetSyncVarNetworkIdentity()

void Mirror.NetworkBehaviour.SetSyncVarNetworkIdentity ( NetworkIdentity  newIdentity, ref NetworkIdentity  identityField, ulong  dirtyBit, ref uint  netIdField  )

protected

Definition at line 788 of file NetworkBehaviour.cs.

        {
            if (GetSyncVarHookGuard(dirtyBit))
                return;
 
            uint newNetId = 0;
            if (newIdentity != null)
            {
                newNetId = newIdentity.netId;
                if (newNetId == 0)
                {
                    Debug.LogWarning($"SetSyncVarNetworkIdentity NetworkIdentity {newIdentity} has a zero netId. Maybe it is not spawned yet?");
                }
            }
 
            //Debug.Log($"SetSyncVarNetworkIdentity NetworkIdentity {GetType().Name} bit:{dirtyBit} netIdField:{netIdField} -> {newNetId}");
            SetSyncVarDirtyBit(dirtyBit);
            netIdField = newNetId;
            // assign new one on the server, and in case we ever need it on client too
            identityField = newIdentity;
        }

SyncVarEqual< T >()

static bool Mirror.NetworkBehaviour.SyncVarEqual< T > ( T  value, ref T  fieldValue  )

staticprotected

Definition at line 923 of file NetworkBehaviour.cs.

        {
            // newly initialized or changed value?
            // value.Equals(fieldValue) allocates without 'where T : IEquatable'
            // seems like we use EqualityComparer to avoid allocations,
            // because not all SyncVars<T> are IEquatable
            return EqualityComparer<T>.Default.Equals(value, fieldValue);
        }

SyncVarGameObjectEqual()

static bool Mirror.NetworkBehaviour.SyncVarGameObjectEqual ( GameObject  newGameObject, uint  netIdField  )

static

Definition at line 455 of file NetworkBehaviour.cs.

        {
            uint newNetId = 0;
            if (newGameObject != null)
            {
                NetworkIdentity identity = newGameObject.GetComponent<NetworkIdentity>();
                if (identity != null)
                {
                    newNetId = identity.netId;
                    if (newNetId == 0)
                    {
                        Debug.LogWarning($"SetSyncVarGameObject GameObject {newGameObject} has a zero netId. Maybe it is not spawned yet?");
                    }
                }
            }
 
            return newNetId == netIdField;
        }

SyncVarNetworkBehaviourEqual< T >()

static bool Mirror.NetworkBehaviour.SyncVarNetworkBehaviourEqual< T > ( T  newBehaviour, NetworkBehaviourSyncVar  syncField  )

staticprotected

Type Constraints

T

:

NetworkBehaviour

Definition at line 826 of file NetworkBehaviour.cs.

                                                                                                                         : NetworkBehaviour
        {
            uint newNetId = 0;
            int newComponentIndex = 0;
            if (newBehaviour != null)
            {
                newNetId = newBehaviour.netId;
                newComponentIndex = newBehaviour.ComponentIndex;
                if (newNetId == 0)
                {
                    Debug.LogWarning($"SetSyncVarNetworkIdentity NetworkIdentity {newBehaviour} has a zero netId. Maybe it is not spawned yet?");
                }
            }
 
            // netId changed?
            return syncField.Equals(newNetId, newComponentIndex);
        }

SyncVarNetworkIdentityEqual()

static bool Mirror.NetworkBehaviour.SyncVarNetworkIdentityEqual ( NetworkIdentity  newIdentity, uint  netIdField  )

static

Definition at line 523 of file NetworkBehaviour.cs.

        {
            uint newNetId = 0;
            if (newIdentity != null)
            {
                newNetId = newIdentity.netId;
                if (newNetId == 0)
                {
                    Debug.LogWarning($"SetSyncVarNetworkIdentity NetworkIdentity {newIdentity} has a zero netId. Maybe it is not spawned yet?");
                }
            }
 
            // netId changed?
            return newNetId == netIdField;
        }

Member Data Documentation

syncInterval

float Mirror.NetworkBehaviour.syncInterval = 0.1f

sync interval for OnSerialize (in seconds)

Definition at line 27 of file NetworkBehaviour.cs.

syncMode

SyncMode Mirror.NetworkBehaviour.syncMode = SyncMode.Observers

sync mode for OnSerialize

Definition at line 20 of file NetworkBehaviour.cs.

syncObjects

readonly List<SyncObject> Mirror.NetworkBehaviour.syncObjects = new List<SyncObject>()

protected

Definition at line 61 of file NetworkBehaviour.cs.

Property Documentation

ComponentIndex

int Mirror.NetworkBehaviour.ComponentIndex

getset

Returns the index of the component on this object

Definition at line 74 of file NetworkBehaviour.cs.

{ get; internal set; }

connectionToClient

NetworkConnectionToClient Mirror.NetworkBehaviour.connectionToClient

get

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

Definition at line 58 of file NetworkBehaviour.cs.

connectionToServer

NetworkConnection Mirror.NetworkBehaviour.connectionToServer

get

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

Definition at line 55 of file NetworkBehaviour.cs.

hasAuthority

bool Mirror.NetworkBehaviour.hasAuthority

get

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

Definition at line 48 of file NetworkBehaviour.cs.

isClient

bool Mirror.NetworkBehaviour.isClient

get

True if this object is on the client and has been spawned by the server.

Definition at line 36 of file NetworkBehaviour.cs.

isClientOnly

bool Mirror.NetworkBehaviour.isClientOnly

get

True if this object is on the client-only, not host.

Definition at line 45 of file NetworkBehaviour.cs.

isLocalPlayer

bool Mirror.NetworkBehaviour.isLocalPlayer

get

True if this object is the the client's own local player.

Definition at line 39 of file NetworkBehaviour.cs.

isServer

bool Mirror.NetworkBehaviour.isServer

get

True if this object is on the server and has been spawned.

Definition at line 33 of file NetworkBehaviour.cs.

isServerOnly

bool Mirror.NetworkBehaviour.isServerOnly

get

True if this object is on the server-only, not host.

Definition at line 42 of file NetworkBehaviour.cs.

netId

uint Mirror.NetworkBehaviour.netId

get

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

Definition at line 51 of file NetworkBehaviour.cs.

netIdentity

NetworkIdentity Mirror.NetworkBehaviour.netIdentity

getset

Returns the NetworkIdentity of this object

Definition at line 71 of file NetworkBehaviour.cs.

{ get; internal set; }

syncVarDirtyBits

ulong Mirror.NetworkBehaviour.syncVarDirtyBits

getprotected

Definition at line 88 of file NetworkBehaviour.cs.

{ get; private set; }