Class NetworkObject

A component used to identify that a GameObject in the network

Inheritance
Object
Object
Component
Behaviour
MonoBehaviour
NetworkObject
Inherited Members
UnityEngine.Component.GetComponentInParent<T>(System.Boolean)
UnityEngine.Object.FindObjectsByType<T>(UnityEngine.FindObjectsSortMode)
UnityEngine.Object.FindObjectsOfType<T>(System.Boolean)
UnityEngine.Object.FindObjectsByType<T>(UnityEngine.FindObjectsInactive, UnityEngine.FindObjectsSortMode)
UnityEngine.Object.FindObjectOfType<T>(System.Boolean)
UnityEngine.Object.FindFirstObjectByType<T>()
UnityEngine.Object.FindAnyObjectByType<T>()
UnityEngine.Object.FindFirstObjectByType<T>(UnityEngine.FindObjectsInactive)
UnityEngine.Object.FindAnyObjectByType<T>(UnityEngine.FindObjectsInactive)
Namespace: Unity.Netcode
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
Boolean
Remarks

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

AutoObjectParentSync

Whether or not to enable automatic NetworkObject parent synchronization.

Declaration
public bool AutoObjectParentSync
Field Value
Type Description
Boolean

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
Boolean

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

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
Boolean
Remarks

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
Boolean

SynchronizeTransform

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

Declaration
public bool SynchronizeTransform
Field Value
Type Description
Boolean
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
Boolean

IsLocalPlayer

Gets if the object is the personal clients player object

Declaration
public bool IsLocalPlayer { get; }
Property Value
Type Description
Boolean

IsOwnedByServer

Gets Whether or not the object is owned by anyone

Declaration
public bool IsOwnedByServer { get; }
Property Value
Type Description
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
Type Description
Boolean

IsPlayerObject

Gets if this object is a player object

Declaration
public bool IsPlayerObject { get; }
Property Value
Type Description
Boolean

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
Nullable<Boolean>

IsSpawned

Gets if the object has yet been spawned across the network

Declaration
public bool IsSpawned { get; }
Property Value
Type Description
Boolean

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
UInt64

OwnerClientId

Gets the ClientId of the owner of this NetworkObject

Declaration
public ulong OwnerClientId { get; }
Property Value
Type Description
UInt64

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
UInt32

Methods

ChangeOwnership(UInt64)

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

Declaration
public void ChangeOwnership(ulong newOwnerClientId)
Parameters
Type Name Description
UInt64 newOwnerClientId

The new owner clientId

Despawn(Boolean)

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
Boolean destroy

(true) the GameObject will be destroyed (false) the GameObject will persist after being despawned

GetObservers()

Returns Observers enumerator

Declaration
public HashSet<ulong>.Enumerator GetObservers()
Returns
Type Description
HashSet.Enumerator<>

Observers enumerator

IsNetworkVisibleTo(UInt64)

Whether or not this object is visible to a specific client

Declaration
public bool IsNetworkVisibleTo(ulong clientId)
Parameters
Type Name Description
UInt64 clientId

The clientId of the client
Returns
Type Description
Boolean

True if the client knows about the object

NetworkHide(List<NetworkObject>, UInt64)

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
UInt64 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(UInt64)
NetworkShow(UInt64) or NetworkShow(List<NetworkObject>, UInt64)

NetworkHide(UInt64)

Hides the NetworkObject from the targeted client.

Declaration
public void NetworkHide(ulong clientId)
Parameters
Type Name Description
UInt64 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>, UInt64)
NetworkShow(UInt64) or NetworkShow(List<NetworkObject>, UInt64)

NetworkShow(List<NetworkObject>, UInt64)

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
UInt64 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(UInt64)
NetworkHide(UInt64) or NetworkHide(List<NetworkObject>, UInt64)

NetworkShow(UInt64)

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

Declaration
public void NetworkShow(ulong clientId)
Parameters
Type Name Description
UInt64 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(UInt64)
NetworkHide(UInt64) or NetworkHide(List<NetworkObject>, UInt64)

RemoveOwnership()

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

Declaration
public void RemoveOwnership()

Spawn(Boolean)

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

Declaration
public void Spawn(bool destroyWithScene = false)
Parameters
Type Name Description
Boolean destroyWithScene

Should the object be destroyed when the scene is changed

SpawnAsPlayerObject(UInt64, Boolean)

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
UInt64 clientId

The clientId who's player object this is
Boolean destroyWithScene

Should the object be destroyed when the scene is changed

SpawnWithOwnership(UInt64, Boolean)

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
UInt64 clientId

The clientId to own the object
Boolean destroyWithScene

Should the object be destroyed when the scene is changed

TryRemoveParent(Boolean)

Removes the parent of the NetworkObject's transform

Declaration
public bool TryRemoveParent(bool worldPositionStays = true)
Parameters
Type Name Description
Boolean 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
Boolean
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, Boolean)

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.
Boolean 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
Boolean

Whether or not reparenting was successful.

TrySetParent(GameObject, Boolean)

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.
Boolean 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
Boolean

Whether or not reparenting was successful.

TrySetParent(Transform, Boolean)

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.
Boolean 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
Boolean

Whether or not reparenting was successful.

WorldPositionStays()

Returns the last known cached WorldPositionStays value for this NetworkObject

Declaration
public bool WorldPositionStays()
Returns
Type Description
Boolean or
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, Boolean) TrySetParent(NetworkObject, Boolean) TrySetParent(Transform, Boolean)