Class NetworkObject

A component used to identify that a GameObject in the network

Inheritance

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.FindObjectsByType(Type, FindObjectsSortMode)

Object.FindObjectsByType(Type, FindObjectsInactive, FindObjectsSortMode)

Object.DontDestroyOnLoad(Object)

Object.DestroyObject(Object, float)

Object.DestroyObject(Object)

Object.FindSceneObjectsOfType(Type)

Object.FindObjectsOfTypeIncludingAssets(Type)

Object.FindObjectsOfType<T>()

Object.FindObjectsByType<T>(FindObjectsSortMode)

Object.FindObjectsOfType<T>(bool)

Object.FindObjectsByType<T>(FindObjectsInactive, FindObjectsSortMode)

Object.FindObjectOfType<T>()

Object.FindObjectOfType<T>(bool)

Object.FindFirstObjectByType<T>()

Object.FindAnyObjectByType<T>()

Object.FindFirstObjectByType<T>(FindObjectsInactive)

Object.FindAnyObjectByType<T>(FindObjectsInactive)

Object.FindObjectsOfTypeAll(Type)

Object.FindObjectOfType(Type)

Object.FindFirstObjectByType(Type)

Object.FindAnyObjectByType(Type)

Object.FindObjectOfType(Type, bool)

Object.FindFirstObjectByType(Type, FindObjectsInactive)

Object.FindAnyObjectByType(Type, FindObjectsInactive)

Object.ToString()

Object.name

Object.hideFlags

object.Equals(object, object)

object.GetType()

object.ReferenceEquals(object, object)

Namespace: Unity.Netcode

Assembly: Unity.Netcode.Runtime.dll

Syntax

[AddComponentMenu("Netcode/Network Object", -99)]
[DisallowMultipleComponent]
public sealed class NetworkObject : MonoBehaviour

Fields

ActiveSceneSynchronization

When set to true and the active scene is changed, this will automatically migrate the NetworkObject into the new active scene on both the server and client instances.

Declaration

public bool ActiveSceneSynchronization

Field Value

Type	Description
bool

Remarks

This only applies to dynamically spawned NetworkObjects.
This only works when using integrated scene management (NetworkSceneManager).

If there are more than one scenes loaded and the currently active scene is unloaded, then typically the SceneManager will automatically assign a new active scene. Similar to DestroyWithScene being set to false, this prevents any NetworkObject from being destroyed with the unloaded active scene by migrating it into the automatically assigned active scene. Additionally, this is can be useful in some seamless scene streaming implementations. Note: Only having ActiveSceneSynchronization set to true will not synchronize clients when changing a NetworkObject's scene via MoveGameObjectToScene. To synchronize clients of a NetworkObject's scene being changed via MoveGameObjectToScene, make sure SceneMigrationSynchronization is enabled (it is by default).

AlwaysReplicateAsRoot

If true, the object will always be replicated as root on clients and the parent will be ignored.

Declaration

public bool AlwaysReplicateAsRoot

Field Value

Type	Description
bool

AutoObjectParentSync

Whether or not to enable automatic NetworkObject parent synchronization.

Declaration

public bool AutoObjectParentSync

Field Value

Type	Description
bool

CheckObjectVisibility

Delegate invoked when the netcode needs to know if the object should be visible to a client, if null it will assume true

Declaration

public NetworkObject.VisibilityDelegate CheckObjectVisibility

Field Value

Type	Description
NetworkObject.VisibilityDelegate

DontDestroyWithOwner

Whether or not to destroy this object if it's owner is destroyed. If true, the objects ownership will be given to the server.

Declaration

public bool DontDestroyWithOwner

Field Value

Type	Description
bool

IncludeTransformWhenSpawning

Delegate invoked when the netcode needs to know if it should include the transform when spawning the object, if null it will assume true

Declaration

public NetworkObject.SpawnDelegate IncludeTransformWhenSpawning

Field Value

Type	Description
NetworkObject.SpawnDelegate

OnMigratedToNewScene

Notifies when the NetworkObject is migrated into a new scene

Declaration

public Action OnMigratedToNewScene

Field Value

Type	Description
Action

Remarks

ActiveSceneSynchronization or SceneMigrationSynchronization (or both) need to be enabled
This only applies to dynamically spawned NetworkObjects.
This only works when using integrated scene management (NetworkSceneManager).

SceneMigrationSynchronization

When enabled (the default), if a NetworkObject is migrated to a different scene (active or not) via MoveGameObjectToScene on the server side all client instances will be synchronized and the NetworkObject migrated into the newly assigned scene. The updated scene migration will get synchronized with late joining clients as well.

Declaration

public bool SceneMigrationSynchronization

Field Value

Type	Description
bool

Remarks

This only applies to dynamically spawned NetworkObjects.
This only works when using integrated scene management (NetworkSceneManager). Note: You can have both ActiveSceneSynchronization and SceneMigrationSynchronization enabled. The primary difference between the two is that SceneMigrationSynchronization only synchronizes clients when the server migrates a NetworkObject to a new scene. If the scene is unloaded and DestroyWithScene is true and ActiveSceneSynchronization is false and the scene is not the currently active scene, then the NetworkObject will be destroyed.

SpawnWithObservers

When set to false, the NetworkObject will be spawned with no observers initially (other than the server)

Declaration

[Tooltip("When false, the NetworkObject will spawn with no observers initially. (default is true)")]
public bool SpawnWithObservers

Field Value

Type	Description
bool

SynchronizeTransform

Determines if the associated NetworkObject's transform will get synchronized when spawned.

Declaration

public bool SynchronizeTransform

Field Value

Type	Description
bool

Remarks

For things like in-scene placed NetworkObjects that have no visual components can help reduce the instance's initial synchronization bandwidth cost. This can also be useful for UI elements that have a predetermined fixed position.

Properties

DestroyWithScene

Gets whether or not the object should be automatically removed when the scene is unloaded.

Declaration

public bool DestroyWithScene { get; set; }

Property Value

Type	Description
bool

IsLocalPlayer

Gets if the object is the personal clients player object

Declaration

public bool IsLocalPlayer { get; }

Property Value

Type	Description
bool

IsOwnedByServer

Gets Whether or not the object is owned by anyone

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

IsPlayerObject

Gets if this object is a player object

Declaration

public bool IsPlayerObject { get; }

Property Value

Type	Description
bool

IsSceneObject

Gets if the object is a SceneObject, null if it's not yet spawned but is a scene object.

Declaration

public bool? IsSceneObject { get; }

Property Value

Type	Description
bool?

IsSpawned

Gets if the object has yet been spawned across the network

Declaration

public bool IsSpawned { get; }

Property Value

Type	Description
bool

NetworkManager

Gets the NetworkManager that owns this NetworkObject instance

Declaration

public NetworkManager NetworkManager { get; }

Property Value

Type	Description
NetworkManager

NetworkObjectId

Gets the unique Id of this object that is synced across the network

Declaration

public ulong NetworkObjectId { get; }

Property Value

Type	Description
ulong

OwnerClientId

Gets the ClientId of the owner of this NetworkObject

Declaration

public ulong OwnerClientId { get; }

Property Value

Type	Description
ulong

PrefabIdHash

Gets the Prefab Hash Id of this object if the object is registerd as a prefab otherwise it returns 0

Declaration

[HideInInspector]
public uint PrefabIdHash { get; }

Property Value

Type	Description
uint

Methods

ChangeOwnership(ulong)

Changes the owner of the object. Can only be called from server

Declaration

public void ChangeOwnership(ulong newOwnerClientId)

Parameters

Type	Name	Description
ulong	newOwnerClientId	The new owner clientId

Despawn(bool)

Despawns the GameObject of this NetworkObject and sends a destroy message for it to all connected clients.

Declaration

public void Despawn(bool destroy = true)

Parameters

Type	Name	Description
bool	destroy	(true) the GameObject will be destroyed (false) the GameObject will persist after being despawned

GetNetworkBehaviourAtOrderIndex(ushort)

Declaration

public NetworkBehaviour GetNetworkBehaviourAtOrderIndex(ushort index)

Parameters

Type	Name	Description
ushort	index

Returns

Type	Description
NetworkBehaviour

GetObservers()

Returns Observers enumerator

Declaration

public HashSet<ulong>.Enumerator GetObservers()

Returns

Type	Description
HashSet<ulong>.Enumerator	Observers enumerator

InstantiateAndSpawn(NetworkManager, ulong, bool, bool, bool, Vector3, Quaternion)

This invokes InstantiateAndSpawn(NetworkObject, ulong, bool, bool, bool, Vector3, Quaternion).

Declaration

public NetworkObject InstantiateAndSpawn(NetworkManager networkManager, ulong ownerClientId = 0, bool destroyWithScene = false, bool isPlayerObject = false, bool forceOverride = false, Vector3 position = default, Quaternion rotation = default)

Parameters

Type	Name	Description
NetworkManager	networkManager	The local instance of the NetworkManager connected to an session in progress.
ulong	ownerClientId	The owner of the NetworkObject instance (defaults to server).
bool	destroyWithScene	Whether the NetworkObject instance will be destroyed when the scene it is located within is unloaded (default is false).
bool	isPlayerObject	Whether the NetworkObject instance is a player object or not (default is false).
bool	forceOverride	Whether you want to force spawning the override when running as a host or server or if you want it to spawn the override for host mode and the source prefab for server. If there is an override, clients always spawn that as opposed to the source prefab (defaults to false).
Vector3	position	The starting poisiton of the NetworkObject instance.
Quaternion	rotation	The starting rotation of the NetworkObject instance.

Returns

Type	Description
NetworkObject	The newly instantiated and spawned NetworkObject prefab instance.

InstantiateAndSpawn(GameObject, NetworkManager, ulong, bool, bool, bool, Vector3, Quaternion)

This invokes InstantiateAndSpawn(NetworkObject, ulong, bool, bool, bool, Vector3, Quaternion).

Declaration

public static NetworkObject InstantiateAndSpawn(GameObject networkPrefab, NetworkManager networkManager, ulong ownerClientId = 0, bool destroyWithScene = false, bool isPlayerObject = false, bool forceOverride = false, Vector3 position = default, Quaternion rotation = default)

Parameters

Type	Name	Description
GameObject	networkPrefab	The NetworkPrefab to instantiate and spawn.
NetworkManager	networkManager	The local instance of the NetworkManager connected to an session in progress.
ulong	ownerClientId	The owner of the NetworkObject instance (defaults to server).
bool	destroyWithScene	Whether the NetworkObject instance will be destroyed when the scene it is located within is unloaded (default is false).
bool	isPlayerObject	Whether the NetworkObject instance is a player object or not (default is false).
bool	forceOverride	Whether you want to force spawning the override when running as a host or server or if you want it to spawn the override for host mode and the source prefab for server. If there is an override, clients always spawn that as opposed to the source prefab (defaults to false).
Vector3	position	The starting poisiton of the NetworkObject instance.
Quaternion	rotation	The starting rotation of the NetworkObject instance.

Returns

Type	Description
NetworkObject	The newly instantiated and spawned NetworkObject prefab instance.

IsNetworkVisibleTo(ulong)

Whether or not this object is visible to a specific client

Declaration

public bool IsNetworkVisibleTo(ulong clientId)

Parameters

Type	Name	Description
ulong	clientId	The clientId of the client

Returns

Type	Description
bool	True if the client knows about the object

NetworkHide(List<NetworkObject>, ulong)

Hides a list of NetworkObjects from the targeted client.

Declaration

public static void NetworkHide(List<NetworkObject> networkObjects, ulong clientId)

Parameters

Type	Name	Description
List<NetworkObject>	networkObjects	The NetworkObjects that will become "netcode invisible" to the targeted client
ulong	clientId	The targeted client

Remarks

Usage: Use to stop sending updates to the targeted client, "netcode invisible", for the currently visible NetworkObjects.

Dynamically Spawned: NetworkObjects will be despawned and destroyed on the targeted client's side.
In-Scene Placed: NetworkObjects will only be despawned on the targeted client's side.

See Also:
NetworkHide(ulong)
NetworkShow(ulong) or NetworkShow(List<NetworkObject>, ulong)

NetworkHide(ulong)

Hides the NetworkObject from the targeted client.

Declaration

public void NetworkHide(ulong clientId)

Parameters

Type	Name	Description
ulong	clientId	The targeted client

Remarks

Usage: Use to stop sending updates to the targeted client, "netcode invisible", for a currently visible NetworkObject.

Dynamically Spawned: NetworkObjects will be despawned and destroyed on the targeted client's side.
In-Scene Placed: NetworkObjects will only be despawned on the targeted client's side.

See Also:
NetworkHide(List<NetworkObject>, ulong)
NetworkShow(ulong) or NetworkShow(List<NetworkObject>, ulong)

NetworkShow(List<NetworkObject>, ulong)

Makes a list of previously hidden NetworkObjects "netcode visible" for the client specified.

Declaration

public static void NetworkShow(List<NetworkObject> networkObjects, ulong clientId)

Parameters

Type	Name	Description
List<NetworkObject>	networkObjects	The objects to become "netcode visible" to the targeted client
ulong	clientId	The targeted client

Remarks

Usage: Use to start sending updates for previously hidden NetworkObjects to the targeted client.

Dynamically Spawned: NetworkObjects will be instantiated and spawned on the targeted client's side.
In-Scene Placed: Already instantiated but despawned NetworkObjects will be spawned on the targeted client's side.

See Also:
NetworkShow(ulong)
NetworkHide(ulong) or NetworkHide(List<NetworkObject>, ulong)

NetworkShow(ulong)

Makes the previously hidden NetworkObject "netcode visible" to the targeted client.

Declaration

public void NetworkShow(ulong clientId)

Parameters

Type	Name	Description
ulong	clientId	The targeted client

Remarks

Usage: Use to start sending updates for a previously hidden NetworkObject to the targeted client.

Dynamically Spawned: NetworkObjects will be instantiated and spawned on the targeted client side.
In-Scene Placed: The instantiated but despawned NetworkObjects will be spawned on the targeted client side.

See Also:
NetworkShow(ulong)
NetworkHide(ulong) or NetworkHide(List<NetworkObject>, ulong)

RemoveOwnership()

Removes all ownership of an object from any client. Can only be called from server

Declaration

public void RemoveOwnership()

Spawn(bool)

Spawns this NetworkObject across the network. Can only be called from the Server

Declaration

public void Spawn(bool destroyWithScene = false)

Parameters

Type	Name	Description
bool	destroyWithScene	Should the object be destroyed when the scene is changed

SpawnAsPlayerObject(ulong, bool)

Spawns a NetworkObject across the network and makes it the player object for the given client

Declaration

public void SpawnAsPlayerObject(ulong clientId, bool destroyWithScene = false)

Parameters

Type	Name	Description
ulong	clientId	The clientId who's player object this is
bool	destroyWithScene	Should the object be destroyed when the scene is changed

SpawnWithOwnership(ulong, bool)

Spawns a NetworkObject across the network with a given owner. Can only be called from server

Declaration

public void SpawnWithOwnership(ulong clientId, bool destroyWithScene = false)

Parameters

Type	Name	Description
ulong	clientId	The clientId to own the object
bool	destroyWithScene	Should the object be destroyed when the scene is changed

TryRemoveParent(bool)

Removes the parent of the NetworkObject's transform

Declaration

public bool TryRemoveParent(bool worldPositionStays = true)

Parameters

Type	Name	Description
bool	worldPositionStays	If true, the parent-relative position, scale and rotation are modified such that the object keeps the same world space position, rotation and scale as before.

Returns

Type	Description
bool

Remarks

This is a more convenient way to remove the parent without having to cast the null value to either GameObject or NetworkObject

TrySetParent(NetworkObject, bool)

Set the parent of the NetworkObject transform.

Declaration

public bool TrySetParent(NetworkObject parent, bool worldPositionStays = true)

Parameters

Type	Name	Description
NetworkObject	parent	The new parent for this NetworkObject transform will be the child of.
bool	worldPositionStays	If true, the parent-relative position, scale and rotation are modified such that the object keeps the same world space position, rotation and scale as before.

Returns

Type	Description
bool	Whether or not reparenting was successful.

TrySetParent(GameObject, bool)

Set the parent of the NetworkObject transform.

Declaration

public bool TrySetParent(GameObject parent, bool worldPositionStays = true)

Parameters

Type	Name	Description
GameObject	parent	The new parent for this NetworkObject transform will be the child of.
bool	worldPositionStays	If true, the parent-relative position, scale and rotation are modified such that the object keeps the same world space position, rotation and scale as before.

Returns

Type	Description
bool	Whether or not reparenting was successful.

TrySetParent(Transform, bool)

Set the parent of the NetworkObject transform.

Declaration

public bool TrySetParent(Transform parent, bool worldPositionStays = true)

Parameters

Type	Name	Description
Transform	parent	The new parent for this NetworkObject transform will be the child of.
bool	worldPositionStays	If true, the parent-relative position, scale and rotation are modified such that the object keeps the same world space position, rotation and scale as before.

Returns

Type	Description
bool	Whether or not reparenting was successful.

WorldPositionStays()

Returns the last known cached WorldPositionStays value for this NetworkObject

Declaration

public bool WorldPositionStays()

Returns

Type	Description
bool	true or false

Remarks

When parenting NetworkObjects, the optional WorldPositionStays value is cached and synchronized with clients. This method provides access to the instance relative cached value. TrySetParent(GameObject, bool) TrySetParent(NetworkObject, bool) TrySetParent(Transform, bool)