Class NetworkBehaviour

Base class for networked components.

Inheritance
Object
NetworkBehaviour
NetworkLerpRigidbody
NetworkRigidbody
NetworkRigidbody2D
NetworkTransformBase
NetworkAnimator
NetworkRoomPlayer
NetworkTransformBase
NetworkVisibility
Namespace: Mirror
Assembly: doc.dll
Syntax
public abstract class NetworkBehaviour : MonoBehaviour

Fields

| Improve this Doc View Source

syncInterval

sync interval for OnSerialize (in seconds)

Declaration
public float syncInterval
Field Value
Type Description
Single
| Improve this Doc View Source

syncMode

sync mode for OnSerialize

Declaration
public SyncMode syncMode
Field Value
Type Description
SyncMode
| Improve this Doc View Source

syncObjects

Declaration
protected readonly List<SyncObject> syncObjects
Field Value
Type Description
List<SyncObject>

Properties

| Improve this Doc View Source

ComponentIndex

Returns the index of the component on this object

Declaration
public int ComponentIndex { get; }
Property Value
Type Description
Int32
| Improve this Doc View Source

connectionToClient

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

Declaration
public NetworkConnection connectionToClient { get; }
Property Value
Type Description
NetworkConnection
| Improve this Doc View Source

connectionToServer

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

Declaration
public NetworkConnection connectionToServer { get; }
Property Value
Type Description
NetworkConnection
| Improve this Doc View Source

hasAuthority

This returns true if this object is the authoritative version of the object in the distributed network application.

Declaration
public bool hasAuthority { get; }
Property Value
Type Description
Boolean
| Improve this Doc View Source

isClient

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

Declaration
public bool isClient { get; }
Property Value
Type Description
Boolean
| Improve this Doc View Source

isClientOnly

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

Declaration
public bool isClientOnly { get; }
Property Value
Type Description
Boolean
| Improve this Doc View Source

isLocalPlayer

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

Declaration
public bool isLocalPlayer { get; }
Property Value
Type Description
Boolean
| Improve this Doc View Source

isServer

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

Declaration
public bool isServer { get; }
Property Value
Type Description
Boolean
| Improve this Doc View Source

isServerOnly

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

Declaration
public bool isServerOnly { get; }
Property Value
Type Description
Boolean
| Improve this Doc View Source

netId

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

Declaration
public uint netId { get; }
Property Value
Type Description
UInt32
| Improve this Doc View Source

netIdentity

Returns the NetworkIdentity of this object

Declaration
public NetworkIdentity netIdentity { get; }
Property Value
Type Description
NetworkIdentity
| Improve this Doc View Source

syncVarDirtyBits

Declaration
protected ulong syncVarDirtyBits { get; }
Property Value
Type Description
UInt64

Methods

| Improve this Doc View Source

ClearAllDirtyBits()

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

Declaration
public void ClearAllDirtyBits()
| Improve this Doc View Source

DeserializeSyncVars(NetworkReader, Boolean)

Declaration
protected virtual void DeserializeSyncVars(NetworkReader reader, bool initialState)
Parameters
Type Name Description
NetworkReader reader
Boolean initialState
| Improve this Doc View Source

GetSyncVarGameObject(UInt32, ref GameObject)

Declaration
protected GameObject GetSyncVarGameObject(uint netId, ref GameObject gameObjectField)
Parameters
Type Name Description
UInt32 netId
GameObject gameObjectField
Returns
Type Description
GameObject
| Improve this Doc View Source

getSyncVarHookGuard(UInt64)

Declaration
protected bool getSyncVarHookGuard(ulong dirtyBit)
Parameters
Type Name Description
UInt64 dirtyBit
Returns
Type Description
Boolean
| Improve this Doc View Source

GetSyncVarNetworkBehaviour<T>(NetworkBehaviour.NetworkBehaviourSyncVar, ref T)

Declaration
protected T GetSyncVarNetworkBehaviour<T>(NetworkBehaviour.NetworkBehaviourSyncVar syncNetBehaviour, ref T behaviourField)
    where T : NetworkBehaviour
Parameters
Type Name Description
NetworkBehaviour.NetworkBehaviourSyncVar syncNetBehaviour
T behaviourField
Returns
Type Description
T
Type Parameters
Name Description
T
| Improve this Doc View Source

GetSyncVarNetworkIdentity(UInt32, ref NetworkIdentity)

Declaration
protected NetworkIdentity GetSyncVarNetworkIdentity(uint netId, ref NetworkIdentity identityField)
Parameters
Type Name Description
UInt32 netId
NetworkIdentity identityField
Returns
Type Description
NetworkIdentity
| Improve this Doc View Source

InitSyncObject(SyncObject)

Declaration
protected void InitSyncObject(SyncObject syncObject)
Parameters
Type Name Description
SyncObject syncObject
| Improve this Doc View Source

IsDirty()

Declaration
public bool IsDirty()
Returns
Type Description
Boolean
| Improve this Doc View Source

OnDeserialize(NetworkReader, Boolean)

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

Declaration
public virtual void OnDeserialize(NetworkReader reader, bool initialState)
Parameters
Type Name Description
NetworkReader reader
Boolean initialState
| Improve this Doc View Source

OnSerialize(NetworkWriter, Boolean)

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

Declaration
public virtual bool OnSerialize(NetworkWriter writer, bool initialState)
Parameters
Type Name Description
NetworkWriter writer
Boolean initialState
Returns
Type Description
Boolean
| Improve this Doc View Source

OnStartAuthority()

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

Declaration
public virtual void OnStartAuthority()
| Improve this Doc View Source

OnStartClient()

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

Declaration
public virtual void OnStartClient()
| Improve this Doc View Source

OnStartLocalPlayer()

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

Declaration
public virtual void OnStartLocalPlayer()
| Improve this Doc View Source

OnStartServer()

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

Declaration
public virtual void OnStartServer()
| Improve this Doc View Source

OnStopAuthority()

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

Declaration
public virtual void OnStopAuthority()
| Improve this Doc View Source

OnStopClient()

Stop event, only called on client and host.

Declaration
public virtual void OnStopClient()
| Improve this Doc View Source

OnStopServer()

Stop event, only called on server and host.

Declaration
public virtual void OnStopServer()
| Improve this Doc View Source

SendCommandInternal(Type, String, NetworkWriter, Int32, Boolean)

Declaration
protected void SendCommandInternal(Type invokeClass, string cmdName, NetworkWriter writer, int channelId, bool requiresAuthority = true)
Parameters
Type Name Description
Type invokeClass
String cmdName
NetworkWriter writer
Int32 channelId
Boolean requiresAuthority
| Improve this Doc View Source

SendRPCInternal(Type, String, NetworkWriter, Int32, Boolean)

Declaration
protected void SendRPCInternal(Type invokeClass, string rpcName, NetworkWriter writer, int channelId, bool includeOwner)
Parameters
Type Name Description
Type invokeClass
String rpcName
NetworkWriter writer
Int32 channelId
Boolean includeOwner
| Improve this Doc View Source

SendTargetRPCInternal(NetworkConnection, Type, String, NetworkWriter, Int32)

Declaration
protected void SendTargetRPCInternal(NetworkConnection conn, Type invokeClass, string rpcName, NetworkWriter writer, int channelId)
Parameters
Type Name Description
NetworkConnection conn
Type invokeClass
String rpcName
NetworkWriter writer
Int32 channelId
| Improve this Doc View Source

SerializeObjectsAll(NetworkWriter)

Declaration
public bool SerializeObjectsAll(NetworkWriter writer)
Parameters
Type Name Description
NetworkWriter writer
Returns
Type Description
Boolean
| Improve this Doc View Source

SerializeObjectsDelta(NetworkWriter)

Declaration
public bool SerializeObjectsDelta(NetworkWriter writer)
Parameters
Type Name Description
NetworkWriter writer
Returns
Type Description
Boolean
| Improve this Doc View Source

SerializeSyncVars(NetworkWriter, Boolean)

Declaration
protected virtual bool SerializeSyncVars(NetworkWriter writer, bool initialState)
Parameters
Type Name Description
NetworkWriter writer
Boolean initialState
Returns
Type Description
Boolean
| Improve this Doc View Source

SetDirtyBit(UInt64)

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

Declaration
public void SetDirtyBit(ulong dirtyBit)
Parameters
Type Name Description
UInt64 dirtyBit
| Improve this Doc View Source

SetSyncVar<T>(T, ref T, UInt64)

Declaration
protected void SetSyncVar<T>(T value, ref T fieldValue, ulong dirtyBit)
Parameters
Type Name Description
T value
T fieldValue
UInt64 dirtyBit
Type Parameters
Name Description
T
| Improve this Doc View Source

SetSyncVarGameObject(GameObject, ref GameObject, UInt64, ref UInt32)

Declaration
protected void SetSyncVarGameObject(GameObject newGameObject, ref GameObject gameObjectField, ulong dirtyBit, ref uint netIdField)
Parameters
Type Name Description
GameObject newGameObject
GameObject gameObjectField
UInt64 dirtyBit
UInt32 netIdField
| Improve this Doc View Source

setSyncVarHookGuard(UInt64, Boolean)

Declaration
protected void setSyncVarHookGuard(ulong dirtyBit, bool value)
Parameters
Type Name Description
UInt64 dirtyBit
Boolean value
| Improve this Doc View Source

SetSyncVarNetworkBehaviour<T>(T, ref T, UInt64, ref NetworkBehaviour.NetworkBehaviourSyncVar)

Declaration
protected void SetSyncVarNetworkBehaviour<T>(T newBehaviour, ref T behaviourField, ulong dirtyBit, ref NetworkBehaviour.NetworkBehaviourSyncVar syncField)
    where T : NetworkBehaviour
Parameters
Type Name Description
T newBehaviour
T behaviourField
UInt64 dirtyBit
NetworkBehaviour.NetworkBehaviourSyncVar syncField
Type Parameters
Name Description
T
| Improve this Doc View Source

SetSyncVarNetworkIdentity(NetworkIdentity, ref NetworkIdentity, UInt64, ref UInt32)

Declaration
protected void SetSyncVarNetworkIdentity(NetworkIdentity newIdentity, ref NetworkIdentity identityField, ulong dirtyBit, ref uint netIdField)
Parameters
Type Name Description
NetworkIdentity newIdentity
NetworkIdentity identityField
UInt64 dirtyBit
UInt32 netIdField
| Improve this Doc View Source

SyncVarEqual<T>(T, ref T)

Declaration
protected bool SyncVarEqual<T>(T value, ref T fieldValue)
Parameters
Type Name Description
T value
T fieldValue
Returns
Type Description
Boolean
Type Parameters
Name Description
T
| Improve this Doc View Source

SyncVarGameObjectEqual(GameObject, UInt32)

Declaration
protected bool SyncVarGameObjectEqual(GameObject newGameObject, uint netIdField)
Parameters
Type Name Description
GameObject newGameObject
UInt32 netIdField
Returns
Type Description
Boolean
| Improve this Doc View Source

SyncVarNetworkBehaviourEqual<T>(T, NetworkBehaviour.NetworkBehaviourSyncVar)

Declaration
protected bool SyncVarNetworkBehaviourEqual<T>(T newBehaviour, NetworkBehaviour.NetworkBehaviourSyncVar syncField)
    where T : NetworkBehaviour
Parameters
Type Name Description
T newBehaviour
NetworkBehaviour.NetworkBehaviourSyncVar syncField
Returns
Type Description
Boolean
Type Parameters
Name Description
T
| Improve this Doc View Source

SyncVarNetworkIdentityEqual(NetworkIdentity, UInt32)

Declaration
protected bool SyncVarNetworkIdentityEqual(NetworkIdentity newIdentity, uint netIdField)
Parameters
Type Name Description
NetworkIdentity newIdentity
UInt32 netIdField
Returns
Type Description
Boolean