Class NetworkBehaviour

The base class to override to write network code. Inherits MonoBehaviour

Inheritance

object

Object

Component

Behaviour

MonoBehaviour

NetworkBehaviour

NetworkAnimator

NetworkNavMeshAgent

NetworkTransform

RpcPipelineTestComponent

Inherited Members

MonoBehaviour.IsInvoking()

MonoBehaviour.CancelInvoke()

MonoBehaviour.Invoke(string, float)

MonoBehaviour.InvokeRepeating(string, float, float)

MonoBehaviour.CancelInvoke(string)

MonoBehaviour.IsInvoking(string)

MonoBehaviour.StartCoroutine(string)

MonoBehaviour.StartCoroutine(string, object)

MonoBehaviour.StartCoroutine(IEnumerator)

MonoBehaviour.StartCoroutine_Auto(IEnumerator)

MonoBehaviour.StopCoroutine(IEnumerator)

MonoBehaviour.StopCoroutine(Coroutine)

MonoBehaviour.StopCoroutine(string)

MonoBehaviour.StopAllCoroutines()

MonoBehaviour.print(object)

MonoBehaviour.useGUILayout

MonoBehaviour.runInEditMode

Behaviour.enabled

Behaviour.isActiveAndEnabled

Component.GetComponent(Type)

Component.GetComponent<T>()

Component.TryGetComponent(Type, out Component)

Component.TryGetComponent<T>(out T)

Component.GetComponent(string)

Component.GetComponentInChildren(Type, bool)

Component.GetComponentInChildren(Type)

Component.GetComponentInChildren<T>(bool)

Component.GetComponentInChildren<T>()

Component.GetComponentsInChildren(Type, bool)

Component.GetComponentsInChildren(Type)

Component.GetComponentsInChildren<T>(bool)

Component.GetComponentsInChildren<T>(bool, List<T>)

Component.GetComponentsInChildren<T>()

Component.GetComponentsInChildren<T>(List<T>)

Component.GetComponentInParent(Type)

Component.GetComponentInParent<T>()

Component.GetComponentsInParent(Type, bool)

Component.GetComponentsInParent(Type)

Component.GetComponentsInParent<T>(bool)

Component.GetComponentsInParent<T>(bool, List<T>)

Component.GetComponentsInParent<T>()

Component.GetComponents(Type)

Component.GetComponents(Type, List<Component>)

Component.GetComponents<T>(List<T>)

Component.GetComponents<T>()

Component.CompareTag(string)

Component.SendMessageUpwards(string, object, SendMessageOptions)

Component.SendMessageUpwards(string, object)

Component.SendMessageUpwards(string)

Component.SendMessageUpwards(string, SendMessageOptions)

Component.SendMessage(string, object)

Component.SendMessage(string)

Component.SendMessage(string, object, SendMessageOptions)

Component.SendMessage(string, SendMessageOptions)

Component.BroadcastMessage(string, object, SendMessageOptions)

Component.BroadcastMessage(string, object)

Component.BroadcastMessage(string)

Component.BroadcastMessage(string, SendMessageOptions)

Component.transform

Component.gameObject

Component.tag

Object.GetInstanceID()

Object.GetHashCode()

Object.Equals(object)

Object.Instantiate(Object, Vector3, Quaternion)

Object.Instantiate(Object, Vector3, Quaternion, Transform)

Object.Instantiate(Object)

Object.Instantiate(Object, Transform)

Object.Instantiate(Object, Transform, bool)

Object.Instantiate<T>(T)

Object.Instantiate<T>(T, Vector3, Quaternion)

Object.Instantiate<T>(T, Vector3, Quaternion, Transform)

Object.Instantiate<T>(T, Transform)

Object.Instantiate<T>(T, Transform, bool)

Object.Destroy(Object, float)

Object.Destroy(Object)

Object.DestroyImmediate(Object, bool)

Object.DestroyImmediate(Object)

Object.FindObjectsOfType(Type)

Object.DontDestroyOnLoad(Object)

Object.DestroyObject(Object, float)

Object.DestroyObject(Object)

Object.FindSceneObjectsOfType(Type)

Object.FindObjectsOfTypeIncludingAssets(Type)

Object.FindObjectsOfType<T>()

Object.FindObjectOfType<T>()

Object.FindObjectsOfTypeAll(Type)

Object.FindObjectOfType(Type)

Object.ToString()

Object.name

Object.hideFlags

object.Equals(object, object)

object.GetType()

object.MemberwiseClone()

object.ReferenceEquals(object, object)

Namespace: MLAPI

Assembly: Unity.Multiplayer.MLAPI.Runtime.dll

Syntax

public abstract class NetworkBehaviour : MonoBehaviour

Properties

CurrentTick

Stores the network tick at the NetworkBehaviourUpdate time This allows sending NetworkVariables not more often than once per network tick, regardless of the update rate

Declaration

public static ushort CurrentTick { get; }

Property Value

Type	Description
ushort

HasNetworkObject

Gets whether or not this NetworkBehaviour instance has a NetworkObject owner.

Declaration

public bool HasNetworkObject { get; }

Property Value

Type	Description
bool

IsClient

Gets if we are executing as client

Declaration

protected bool IsClient { get; }

Property Value

Type	Description
bool

IsHost

Gets if we are executing as Host, I.E Server and Client

Declaration

protected bool IsHost { get; }

Property Value

Type	Description
bool

IsLocalPlayer

Gets if the object is the the personal clients player object

Declaration

public bool IsLocalPlayer { get; }

Property Value

Type	Description
bool

IsOwnedByServer

Gets Whether or not the object has a owner

Declaration

public bool IsOwnedByServer { get; }

Property Value

Type	Description
bool

IsOwner

Gets if the object is owned by the local player or if the object is the local player object

Declaration

public bool IsOwner { get; }

Property Value

Type	Description
bool

IsServer

Gets if we are executing as server

Declaration

protected static bool IsServer { get; }

Property Value

Type	Description
bool

NetworkBehaviourId

Gets NetworkId for this NetworkBehaviour from the owner NetworkObject

Declaration

public ushort NetworkBehaviourId { get; }

Property Value

Type	Description
ushort

NetworkManager

Gets the NetworkManager that owns this NetworkBehaviour instance

Declaration

public NetworkManager NetworkManager { get; }

Property Value

Type	Description
NetworkManager

NetworkObject

Gets the NetworkObject that owns this NetworkBehaviour instance

Declaration

public NetworkObject NetworkObject { get; }

Property Value

Type	Description
NetworkObject

NetworkObjectId

Gets the NetworkId of the NetworkObject that owns this NetworkBehaviour

Declaration

public ulong NetworkObjectId { get; }

Property Value

Type	Description
ulong

OwnerClientId

Gets the ClientId that owns the NetworkObject

Declaration

public ulong OwnerClientId { get; }

Property Value

Type	Description
ulong

Methods

GetNetworkBehaviour(ushort)

Returns a the NetworkBehaviour with a given BehaviourId for the current NetworkObject

Declaration

protected NetworkBehaviour GetNetworkBehaviour(ushort behaviourId)

Parameters

Type	Name	Description
ushort	behaviourId	The behaviourId to return

Returns

Type	Description
NetworkBehaviour	Returns NetworkBehaviour with given behaviourId

GetNetworkObject(ulong)

Gets the local instance of a object with a given NetworkId

Declaration

protected NetworkObject GetNetworkObject(ulong networkId)

Parameters

Type	Name	Description
ulong	networkId

Returns

Type	Description
NetworkObject

NetworkStart()

Gets called when message handlers are ready to be registered and the network is setup

Declaration

public virtual void NetworkStart()

NetworkStart(Stream)

Gets called when message handlers are ready to be registered and the network is setup. Provides a Payload if it was provided

Declaration

public virtual void NetworkStart(Stream stream)

Parameters

Type	Name	Description
Stream	stream	The stream containing the spawn payload

OnGainedOwnership()

Gets called when the local client gains ownership of this object

Declaration

public virtual void OnGainedOwnership()

OnLostOwnership()

Gets called when we loose ownership of this object

Declaration

public virtual void OnLostOwnership()