Class NetworkObject

Namespace

Netick

Assembly

Netick.dll

Any GameObject which needs to be synced/replicated must have a Network Object component. It’s the component that tells Netick a GameObject is networked. Although not every child GameObject needs it, only the root has to have a Network Object.

[AddComponentMenu("Netick/Network Object")]
[DisallowMultipleComponent]
[SerializeField]
public sealed class NetworkObject : MonoBehaviour

Inheritance

object

Object

Component

Behaviour

MonoBehaviour

NetworkObject

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

Component.GetComponentInParent(Type)

Component.GetComponentInParent<T>(bool)

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.FindObjectsOfType(Type, bool)

Object.DontDestroyOnLoad(Object)

Object.DestroyObject(Object, float)

Object.DestroyObject(Object)

Object.FindSceneObjectsOfType(Type)

Object.FindObjectsOfTypeIncludingAssets(Type)

Object.FindObjectsOfType<T>()

Object.FindObjectsOfType<T>(bool)

Object.FindObjectOfType<T>()

Object.FindObjectOfType<T>(bool)

Object.FindObjectsOfTypeAll(Type)

Object.FindObjectOfType(Type)

Object.FindObjectOfType(Type, bool)

Object.ToString()

Object.name

Object.hideFlags

object.Equals(object, object)

object.GetType()

object.ReferenceEquals(object, object)

Extension Methods

ComponentExtensions.SetEnabled(Component, NetworkSandbox, bool)

Constructors

NetworkObject()

public NetworkObject()

Properties

HasValidId

Returns true if this NetworkObject has been added to the simulation by Netick, and thus has a valid id.

[SerializeField]
public bool HasValidId { get; }

Property Value

bool

Id

The network id of this NetworkObject.

public int Id { get; }

Property Value

int

InputSource

Returns the source NetworkPlayer (NetworkPeer/ServerConnection) of inputs for this NetworkObject. If the source of inputs is remote (from a client) it returns that ServerConnection, while on the input source itself it returns the local NetworkPlayer.

public NetworkPlayer InputSource { get; }

Property Value

NetworkPlayer

IsInputSource

Returns true if this LocalPlayer is providing inputs for this NetworkObject.

public bool IsInputSource { get; }

Property Value

bool

IsOwner

Returns true if this Sandbox is the owner of this NetworkObject. In this version of Netick: Server=Owner.

public bool IsOwner { get; }

Property Value

bool

IsPrefabObject

public bool IsPrefabObject { get; }

Property Value

bool

IsProxy

Returns true if we neither provide inputs nor own this NetworkObject.

public bool IsProxy { get; }

Property Value

bool

IsResimulating

Returns true if we are currently resimulating a previous input of the past. On the server, it always returns false since only the clients resimulate.

public bool IsResimulating { get; }

Property Value

bool

IsSceneObject

[SerializeField]
public bool IsSceneObject { get; }

Property Value

bool

IsSpawnPredicted

public bool IsSpawnPredicted { get; }

Property Value

bool

Parent

The NetworkObject parent of this object.

public NetworkObject Parent { get; }

Property Value

NetworkObject

PredictionMode

public Relevancy PredictionMode { get; }

Property Value

Relevancy

Sandbox

The NetworkSandbox containing this NetworkObject.

public NetworkSandbox Sandbox { get; }

Property Value

NetworkSandbox

SpawnPredictionKey

public SpawnPredictionKey SpawnPredictionKey { get; }

Property Value

SpawnPredictionKey

SpawnTick

The tick which this object was spawned at.

public Tick SpawnTick { get; }

Property Value

Tick

Methods

GetBehaviourById<T>(int)

public T GetBehaviourById<T>(int id) where T : NetworkBehaviour

Parameters

id int

Returns

T

Type Parameters

T

GetBehaviour<T>()

public T GetBehaviour<T>() where T : NetworkBehaviour

Returns

T

Type Parameters

T

GetSceneId()

public int GetSceneId()

Returns

int

PermitInput(NetworkPlayer)

[Owner Only] Permit source to provide inputs to this object.

public void PermitInput(NetworkPlayer source)

Parameters

source NetworkPlayer

The player to be given permission.

RevokeInput()

[Owner Only] Removes the current Input Source (InputSource) of this object.

public void RevokeInput()

SetObjectDirty()

public void SetObjectDirty()

SetParent(NetworkObject)

[Owner/InputSource Only] Changes the parent of this object.

public void SetParent(NetworkObject obj)

Parameters

obj NetworkObject

The object which will become the parent of this object.