Skip to main content

MLAPI.NetworkBehaviour

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

Inheritance#

System.Dynamic.ExpandoObject

System.Dynamic.ExpandoObject

System.Dynamic.ExpandoObject

System.Dynamic.ExpandoObject

System.Dynamic.ExpandoObject

System.Dynamic.ExpandoObject

System.Dynamic.ExpandoObject

System.Dynamic.ExpandoObject

System.Dynamic.ExpandoObject

System.Dynamic.ExpandoObject

Inherited Members#

MonoBehaviour.IsInvoking()

MonoBehaviour.CancelInvoke()

MonoBehaviour.Invoke(String, Single)

MonoBehaviour.InvokeRepeating(String, Single, Single)

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.GetComponent(String)

Component.GetComponentInChildren(Type, Boolean)

Component.GetComponentInChildren(Type)

Component.GetComponentInChildren<T>(Boolean)

Component.GetComponentInChildren<T>()

Component.GetComponentsInChildren(Type, Boolean)

Component.GetComponentsInChildren(Type)

Component.GetComponentsInChildren<T>(Boolean)

Component.GetComponentsInChildren<T>(Boolean, List<T>)"

Component.GetComponentsInChildren<T>()

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

Component.GetComponentInParent(Type)

Component.GetComponentInParent<T>()

Component.GetComponentsInParent(Type, Boolean)

Component.GetComponentsInParent(Type)

Component.GetComponentsInParent<T>(Boolean)

Component.GetComponentsInParent<T>(Boolean, 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

Component.rigidbody

Component.rigidbody2D

Component.camera

Component.light

Component.animation

Component.constantForce

Component.renderer

Component.audio

Component.guiText

Component.networkView

Component.guiElement

Component.guiTexture

Component.collider

Component.collider2D

Component.hingeJoint

Component.particleEmitter

Component.particleSystem

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, Boolean)

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, Boolean)"

Object.Destroy(Object, Single)

Object.Destroy(Object)

Object.DestroyImmediate(Object, Boolean)

Object.DestroyImmediate(Object)

Object.FindObjectsOfType(Type)

Object.DontDestroyOnLoad(Object)

Object.DestroyObject(Object, Single)

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: System.Dynamic.ExpandoObject#
Assembly: MLAPI.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#

TypeDescription
System.UInt16

HasNetworkObject#

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

Declaration#

public bool HasNetworkObject { get; }

Property Value#

TypeDescription
System.Boolean

IsClient#

Gets if we are executing as client

Declaration#

protected bool IsClient { get; }

Property Value#

TypeDescription
System.Boolean

IsHost#

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

Declaration#

protected bool IsHost { get; }

Property Value#

TypeDescription
System.Boolean

IsLocalPlayer#

Gets if the object is the the personal clients player object

Declaration#

public bool IsLocalPlayer { get; }

Property Value#

TypeDescription
System.Boolean

IsOwnedByServer#

Gets Whether or not the object has a owner

Declaration#

public bool IsOwnedByServer { get; }

Property Value#

TypeDescription
System.Boolean

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#

TypeDescription
System.Boolean

IsServer#

Gets if we are executing as server

Declaration#

protected static bool IsServer { get; }

Property Value#

TypeDescription
System.Boolean

NetworkBehaviourId#

Gets NetworkId for this NetworkBehaviour from the owner NetworkObject

Declaration#

public ushort NetworkBehaviourId { get; }

Property Value#

TypeDescription
System.UInt16

NetworkManager#

Gets the NetworkManager that owns this NetworkBehaviour instance

Declaration#

public NetworkManager NetworkManager { get; }

Property Value#

TypeDescription
NetworkManager

NetworkObject#

Gets the NetworkObject that owns this NetworkBehaviour instance

Declaration#

public NetworkObject NetworkObject { get; }

Property Value#

TypeDescription
NetworkObject

NetworkObjectId#

Gets the NetworkId of the NetworkObject that owns this NetworkBehaviour

Declaration#

public ulong NetworkObjectId { get; }

Property Value#

TypeDescription
System.UInt64

OwnerClientId#

Gets the ClientId that owns the NetworkObject

Declaration#

public ulong OwnerClientId { get; }

Property Value#

TypeDescription
System.UInt64

Methods#

GetNetworkBehaviour(UInt16)#

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

Declaration#

protected NetworkBehaviour GetNetworkBehaviour(ushort behaviourId)

Parameters#

TypeNameDescription
System.UInt16behaviourIdThe behaviourId to return

Returns#

TypeDescription
NetworkBehaviourReturns NetworkBehaviour with given behaviourId

GetNetworkObject(UInt64)#

Gets the local instance of a object with a given NetworkId

Declaration#

protected NetworkObject GetNetworkObject(ulong networkId)

Parameters#

TypeNameDescription
System.UInt64networkId

Returns#

TypeDescription
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#

TypeNameDescription
System.IO.StreamstreamThe 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()