Struct NetworkBehaviourReference

A helper struct for serializing NetworkBehaviours over the network. Can be used in RPCs and NetworkVariable<T>. Note: network ids get recycled by the NetworkManager after a while. So a reference pointing to

Implements

INetworkSerializable

IEquatable<NetworkBehaviourReference>

Inherited Members

ValueType.ToString()

object.Equals(object, object)

object.GetType()

object.ReferenceEquals(object, object)

Namespace: Unity.Netcode

Assembly: Unity.Netcode.Runtime.dll

Syntax

public struct NetworkBehaviourReference : INetworkSerializable, IEquatable<NetworkBehaviourReference>

Constructors

NetworkBehaviourReference(NetworkBehaviour)

Creates a new instance of the NetworkBehaviourReference<T> struct.

Declaration

public NetworkBehaviourReference(NetworkBehaviour networkBehaviour)

Parameters

Type	Name	Description
NetworkBehaviour	networkBehaviour	The NetworkBehaviour to reference.

Exceptions

Type	Condition
ArgumentException	Thrown when the provided NetworkBehaviour does not have an associated NetworkObject. This can happen if the behaviour is not properly attached to a networked GameObject.

Methods

Equals(object)

Declaration

public override bool Equals(object obj)

Parameters

Type	Name	Description
object	obj

Returns

Type	Description
bool

Overrides

ValueType.Equals(object)

Equals(NetworkBehaviourReference)

Declaration

public bool Equals(NetworkBehaviourReference other)

Parameters

Type	Name	Description
NetworkBehaviourReference	other

Returns

Type	Description
bool

GetHashCode()

Declaration

public override int GetHashCode()

Returns

Type	Description
int

Overrides

ValueType.GetHashCode()

NetworkSerialize<T>(BufferSerializer<T>)

Provides bi-directional serialization to read and write the desired data to serialize this type.

Declaration

public void NetworkSerialize<T>(BufferSerializer<T> serializer) where T : IReaderWriter

Parameters

Type	Name	Description
BufferSerializer<T>	serializer	The serializer to use to read and write the data.

Type Parameters

Name	Description
T	Either BufferSerializerReader or BufferSerializerWriter, depending whether the serializer is in read mode or write mode.

TryGet(out NetworkBehaviour, NetworkManager)

Tries to get the NetworkBehaviour referenced by this reference.

Declaration

public bool TryGet(out NetworkBehaviour networkBehaviour, NetworkManager networkManager = null)

Parameters

Type	Name	Description
NetworkBehaviour	networkBehaviour	The NetworkBehaviour which was found. Null if the corresponding NetworkObject was not found.
NetworkManager	networkManager	The networkmanager. Uses Singleton to resolve if null.

Returns

Type	Description
bool	True if the NetworkBehaviour was found; False if the NetworkBehaviour was not found. This can happen if the corresponding NetworkObject has not been spawned yet. you can try getting the reference at a later point in time.

TryGet<T>(out T, NetworkManager)

Tries to get the NetworkBehaviour referenced by this reference.

Declaration

public bool TryGet<T>(out T networkBehaviour, NetworkManager networkManager = null) where T : NetworkBehaviour

Parameters

Type	Name	Description
T	networkBehaviour	The NetworkBehaviour which was found. Null if the corresponding NetworkObject was not found.
NetworkManager	networkManager	The networkmanager. Uses Singleton to resolve if null.

Returns

Type	Description
bool	True if the NetworkBehaviour was found; False if the NetworkBehaviour was not found. This can happen if the corresponding NetworkObject has not been spawned yet. you can try getting the reference at a later point in time.

Type Parameters

Name	Description
T	The type of the networkBehaviour for convenience.

Operators

implicit operator NetworkBehaviourReference(NetworkBehaviour)

Implicitly convert NetworkBehaviour to NetworkBehaviourReference.

Declaration

public static implicit operator NetworkBehaviourReference(NetworkBehaviour networkBehaviour)

Parameters

Type	Name	Description
NetworkBehaviour	networkBehaviour	The NetworkBehaviour to convert from.

Returns

Type	Description
NetworkBehaviourReference	The NetworkBehaviourReference created from the NetworkBehaviour passed in as a parameter

implicit operator NetworkBehaviour(NetworkBehaviourReference)

Implicitly convert NetworkBehaviourReference to NetworkBehaviour.

Declaration

public static implicit operator NetworkBehaviour(NetworkBehaviourReference networkBehaviourRef)

Parameters

Type	Name	Description
NetworkBehaviourReference	networkBehaviourRef	The NetworkBehaviourReference to convert from.

Returns

Type	Description
NetworkBehaviour	The NetworkBehaviour this class is holding a reference to

Implements

INetworkSerializable

IEquatable<T>