This static class provides utility methods for working with NetworkBehaviour objects. More...

Classes
struct	ArrayInitializer
	A utility structure for initializing NetworkArray and NetworkLinkedList with inline initialization. More...

struct	DictionaryInitializer
	A utility structure for initializing NetworkDictionary with inline initialization. More...

struct	MetaData
	This structure holds metadata for a NetworkBehaviour object. More...

Static Public Member Functions
static T[]	CloneArray< T > (T[] array)
	Creates a new array that is a clone of the specified array.

static void	CopyFromNetworkArray< T > (NetworkArray< T > networkArray, ref T[] dstArray)
	Copies the values from a NetworkArray to a destination array.

static void	CopyFromNetworkDictionary< D, K, V > (NetworkDictionary< K, V > networkDictionary, ref D dictionary)
	Copies the values from a NetworkDictionary to a destination dictionary.

static void	CopyFromNetworkList< T > (NetworkLinkedList< T > networkList, ref T[] dstArray)
	Copies the values from a NetworkLinkedList to a destination array.

static MetaData	GetMetaData (Type type)
	Retrieves the metadata for a given type.

static int	GetRpcStaticIndexOrThrow (string key)
	Retrieves the index of a static RPC (Remote Procedure Call) based on its key.

static int	GetStaticWordCount (Type type)
	Retrieves the static word count for a given type. If the word count for the type has not been computed yet, it is computed and stored.

static int	GetWordCount (NetworkBehaviour behaviour)
	Retrieves the word count for a given NetworkBehaviour. If the NetworkBehaviour has a dynamic word count, it is returned. Otherwise, the static word count for the type of the NetworkBehaviour is returned.

static bool	HasStaticWordCount (Type type)
	Checks if a given type has a static word count. A type has a static word count if it is a subclass of NetworkBehaviour and its word count is non-negative.

static void	InitializeNetworkArray< T > (NetworkArray< T > networkArray, T[] sourceArray, string name)
	Initializes a NetworkArray with the values from a source array.

static void	InitializeNetworkDictionary< D, K, V > (NetworkDictionary< K, V > networkDictionary, D dictionary, string name)
	Initializes a NetworkDictionary with the values from a source dictionary.

static void	InitializeNetworkList< T > (NetworkLinkedList< T > networkList, T[] sourceArray, string name)
	Initializes a NetworkLinkedList with the values from a source array.

static void	InternalOnDestroy (SimulationBehaviour obj)
	This method is not meant to be called directly. Calls are injected by the Weaver.

static void	InternalOnDisable (SimulationBehaviour obj)
	This method is not meant to be called directly. Calls are injected by the Weaver.

static void	InternalOnEnable (SimulationBehaviour obj)
	This method is not meant to be called directly. Calls are injected by the Weaver.

static SerializableDictionary< K, V >	MakeSerializableDictionary< K, V > (Dictionary< K, V > dictionary)
	Wraps a Dictionary in a SerializableDictionary.

static void	NotifyLocalSimulationNotAllowedToSendRpc (string rpc, NetworkObject obj, int sources)
	Logs an error message indicating that a local simulation is not allowed to send a specific RPC.

static void	NotifyLocalTargetedRpcCulled (PlayerRef player, string methodName)
	Logs a warning message indicating that a local targeted RPC was culled.

static void	NotifyNetworkUnwrapFailed< T > (T wrapper, Type valueType)
	Logs a warning message indicating that a network unwrap operation failed.

static void	NotifyNetworkWrapFailed< T > (T value)
	Logs a warning message indicating that a network wrap operation failed.

static void	NotifyNetworkWrapFailed< T > (T value, Type wrapperType)
	Logs a warning message indicating that a network wrap operation failed for a specific wrapper type.

static void	NotifyRpcPayloadSizeExceeded (string rpc, int size)
	Logs an error message indicating that the target of a Remote Procedure Call (RPC) payload is too large.

static void	NotifyRpcTargetUnreachable (PlayerRef player, string rpc)
	Logs an error message indicating that the target of a Remote Procedure Call (RPC) is not reachable.

static void	RegisterMetaData (Type type)
	Registers the metadata for a given type. This method checks if the type has an override for the "ReplicateTo" method and stores this information in the metadata. If the metadata for the type already exists, this method does nothing.

static void	RegisterRpcInvokeDelegates (Type type)
	Registers the RPC (Remote Procedure Call) invoke delegates for a given type. This method is only available when the FUSION_UNITY compilation symbol is defined.

static bool	ShouldRegisterRpcInvokeDelegates (Type type)
	Determines whether the RPC (Remote Procedure Call) invoke delegates should be registered for a given type.

static void	ThrowIfBehaviourNotInitialized (NetworkBehaviour behaviour)
	Checks if the NetworkBehaviour object is initialized and throws an exception if it is not.

static bool	TryGetRpcInvokeDelegateArray (Type type, out RpcInvokeData[] delegates)
	Tries to get the RPC (Remote Procedure Call) invoke delegate array for a given type.

static bool	TryGetRpcStaticInvokeDelegate (int index, out RpcStaticInvokeDelegate del)
	Tries to get the static RPC (Remote Procedure Call) invoke delegate based on its index.

Static Public Attributes
static bool	InvokeRpc = false
	A static field that determines whether to invoke RPC (Remote Procedure Call). When set to true, RPCs are invoked. When set to false, RPCs are not invoked. Default value is false.

Detailed Description

This static class provides utility methods for working with NetworkBehaviour objects.

Member Function Documentation

◆ CloneArray< T >()

static T[] CloneArray< T > ( T[] array )

static

Creates a new array that is a clone of the specified array.

Template Parameters

T	The type of the elements in the array.

Parameters

array The array to clone.

Returns: A new array that is a clone of the specified array. If the specified array is null, an empty array is returned.

◆ CopyFromNetworkArray< T >()

static void CopyFromNetworkArray< T >	(	NetworkArray< T >	networkArray,
		ref T[]	dstArray
	)

static

Copies the values from a NetworkArray to a destination array.

Template Parameters

T	The type of the elements in the NetworkArray and destination array.

Parameters

networkArray	The NetworkArray from which to copy the values.
dstArray	The destination array to which to copy the values.

If the length of the destination array is not equal to the length of the NetworkArray, a new array of the correct length is created and assigned to the destination array.

Type Constraints

T

:

unmanaged

◆ CopyFromNetworkDictionary< D, K, V >()

static void CopyFromNetworkDictionary< D, K, V >	(	NetworkDictionary< K, V >	networkDictionary,
		ref D	dictionary
	)

static

Copies the values from a NetworkDictionary to a destination dictionary.

Template Parameters

D	The type of the destination dictionary. Must implement IDictionary{K, V} and have a parameterless constructor.
K	The type of the keys in the NetworkDictionary and destination dictionary. Must be unmanaged.
V	The type of the values in the NetworkDictionary and destination dictionary. Must be unmanaged.

Parameters

networkDictionary	The NetworkDictionary from which to copy the values.
dictionary	The destination dictionary to which to copy the values. If the destination dictionary is null, a new dictionary of type D is created.

Type Constraints

D	:	IDictionary
D	:	K
D	:	V
D	:	new()
K	:	unmanaged
V	:	unmanaged

◆ CopyFromNetworkList< T >()

static void CopyFromNetworkList< T >	(	NetworkLinkedList< T >	networkList,
		ref T[]	dstArray
	)

static

Copies the values from a NetworkLinkedList to a destination array.

Template Parameters

T	The type of the elements in the NetworkLinkedList and destination array.

Parameters

networkList	The NetworkLinkedList from which to copy the values.
dstArray	The destination array to which to copy the values. If the length of the destination array is not equal to the count of the NetworkLinkedList, a new array of the correct length is created and assigned to the destination array.

Type Constraints

T

:

unmanaged

◆ GetMetaData()

static MetaData GetMetaData ( Type type )

static

Retrieves the metadata for a given type.

Parameters

type	The type for which to retrieve the metadata.

Returns: The metadata for the given type if it exists; otherwise, the default value.

◆ GetRpcStaticIndexOrThrow()

static int GetRpcStaticIndexOrThrow ( string key )

static

Retrieves the index of a static RPC (Remote Procedure Call) based on its key.

Parameters

key	The key of the static RPC.

Returns: The index of the static RPC if it exists.

Exceptions

System.ArgumentOutOfRangeException Thrown when the static RPC does not exist.

◆ GetStaticWordCount()

static int GetStaticWordCount ( Type type )

static

Retrieves the static word count for a given type. If the word count for the type has not been computed yet, it is computed and stored.

Parameters

type	The type for which to retrieve the static word count.

Returns: The static word count for the given type.

Exceptions

System.ArgumentException	Thrown when the provided type is not a subclass of NetworkBehaviour.
System.InvalidOperationException	Thrown when the provided type does not have a weaved attribute or its word count is negative.

◆ GetWordCount()

static int GetWordCount ( NetworkBehaviour behaviour )

static

Retrieves the word count for a given NetworkBehaviour. If the NetworkBehaviour has a dynamic word count, it is returned. Otherwise, the static word count for the type of the NetworkBehaviour is returned.

Parameters

behaviour The NetworkBehaviour for which to retrieve the word count.

Returns: The word count for the given NetworkBehaviour.

Exceptions

System.InvalidOperationException Thrown when the dynamic word count or the static word count is negative.

◆ HasStaticWordCount()

static bool HasStaticWordCount ( Type type )

static

Checks if a given type has a static word count. A type has a static word count if it is a subclass of NetworkBehaviour and its word count is non-negative.

Parameters

type	The type to check.

Returns: True if the type has a static word count, false otherwise.

Exceptions

System.ArgumentException	Thrown when the provided type is not a subclass of NetworkBehaviour.
System.InvalidOperationException	Thrown when the provided type does not have a weaved attribute.

◆ InitializeNetworkArray< T >()

static void InitializeNetworkArray< T >	(	NetworkArray< T >	networkArray,
		T[]	sourceArray,
		string	name
	)

static

Initializes a NetworkArray with the values from a source array.

Template Parameters

T	The type of the elements in the NetworkArray and source array.

Parameters

networkArray	The NetworkArray to initialize.
sourceArray	The source array from which to copy the values.
name	The name of the NetworkArray for logging purposes.

If the length of the source array is greater than the length of the NetworkArray, a warning is logged and only the first elements up to the length of the NetworkArray are copied.

Type Constraints

T

:

unmanaged

◆ InitializeNetworkDictionary< D, K, V >()

static void InitializeNetworkDictionary< D, K, V >	(	NetworkDictionary< K, V >	networkDictionary,
		D	dictionary,
		string	name
	)

static

Initializes a NetworkDictionary with the values from a source dictionary.

Template Parameters

D	The type of the source dictionary. Must implement IDictionary{K, V}.
K	The type of the keys in the NetworkDictionary and source dictionary. Must be unmanaged.
V	The type of the values in the NetworkDictionary and source dictionary. Must be unmanaged.

Parameters

networkDictionary	The NetworkDictionary to initialize.
dictionary	The source dictionary from which to copy the values.
name	The name of the NetworkDictionary for logging purposes.

If the count of the source dictionary is greater than the capacity of the NetworkDictionary, a warning is logged and only the first elements up to the capacity of the NetworkDictionary are copied.

Type Constraints

D	:	IDictionary
D	:	K
D	:	V
K	:	unmanaged
V	:	unmanaged

◆ InitializeNetworkList< T >()

static void InitializeNetworkList< T >	(	NetworkLinkedList< T >	networkList,
		T[]	sourceArray,
		string	name
	)

static

Initializes a NetworkLinkedList with the values from a source array.

Template Parameters

T	The type of the elements in the NetworkLinkedList and source array. Must be unmanaged.

Parameters

networkList	The NetworkLinkedList to initialize.
sourceArray	The source array from which to copy the values.
name	The name of the NetworkLinkedList for logging purposes.

If the length of the source array is greater than the capacity of the NetworkLinkedList, a warning is logged and only the first elements up to the capacity of the NetworkLinkedList are copied.

Type Constraints

T

:

unmanaged

◆ InternalOnDestroy()

static void InternalOnDestroy ( SimulationBehaviour obj )

static

This method is not meant to be called directly. Calls are injected by the Weaver.

Parameters

obj	SimulationBehaviour object.

◆ InternalOnDisable()

static void InternalOnDisable ( SimulationBehaviour obj )

static

This method is not meant to be called directly. Calls are injected by the Weaver.

Parameters

obj	SimulationBehaviour object.

◆ InternalOnEnable()

static void InternalOnEnable ( SimulationBehaviour obj )

static

This method is not meant to be called directly. Calls are injected by the Weaver.

Parameters

obj	SimulationBehaviour object.

◆ MakeSerializableDictionary< K, V >()

static SerializableDictionary< K, V > MakeSerializableDictionary< K, V > ( Dictionary< K, V > dictionary )

static

Wraps a Dictionary in a SerializableDictionary.

Template Parameters

K	The type of the keys in the dictionary. Must be unmanaged.
V	The type of the values in the dictionary. Must be unmanaged.

Parameters

dictionary The dictionary to wrap.

Returns: A SerializableDictionary that wraps the specified dictionary.

Type Constraints

K	:	unmanaged
V	:	unmanaged

◆ NotifyLocalSimulationNotAllowedToSendRpc()

static void NotifyLocalSimulationNotAllowedToSendRpc	(	string	rpc,
		NetworkObject	obj,
		int	sources
	)

static

Logs an error message indicating that a local simulation is not allowed to send a specific RPC.

Parameters

rpc	The name of the RPC that was attempted.
obj	The network object on which the RPC was attempted.
sources	The sources from which the RPC was attempted.

◆ NotifyLocalTargetedRpcCulled()

static void NotifyLocalTargetedRpcCulled	(	PlayerRef	player,
		string	methodName
	)

static

Logs a warning message indicating that a local targeted RPC was culled.

Parameters

player	The player reference for which the RPC was culled.
methodName	The name of the method that was culled.

◆ NotifyNetworkUnwrapFailed< T >()

static void NotifyNetworkUnwrapFailed< T >	(	T	wrapper,
		Type	valueType
	)

static

Logs a warning message indicating that a network unwrap operation failed.

Template Parameters

T	The type of the wrapper that failed to be unwrapped.

Parameters

wrapper	The wrapper that failed to be unwrapped.
valueType	The type that was attempted to be obtained from the unwrap operation.

◆ NotifyNetworkWrapFailed< T >() [1/2]

static void NotifyNetworkWrapFailed< T > ( T value )

static

Logs a warning message indicating that a network wrap operation failed.

Template Parameters

T	The type of the value that failed to be wrapped.

Parameters

value The value that failed to be wrapped.

◆ NotifyNetworkWrapFailed< T >() [2/2]

static void NotifyNetworkWrapFailed< T >	(	T	value,
		Type	wrapperType
	)

static

Logs a warning message indicating that a network wrap operation failed for a specific wrapper type.

Template Parameters

T	The type of the value that failed to be wrapped.

Parameters

value	The value that failed to be wrapped.
wrapperType	The type that was attempted to be used as a wrapper.

◆ NotifyRpcPayloadSizeExceeded()

static void NotifyRpcPayloadSizeExceeded	(	string	rpc,
		int	size
	)

static

Logs an error message indicating that the target of a Remote Procedure Call (RPC) payload is too large.

Parameters

size	Size of the payload.
rpc	The name of the RPC that was attempted.

◆ NotifyRpcTargetUnreachable()

static void NotifyRpcTargetUnreachable	(	PlayerRef	player,
		string	rpc
	)

static

Logs an error message indicating that the target of a Remote Procedure Call (RPC) is not reachable.

Parameters

player	The player reference that is not reachable.
rpc	The name of the RPC that was attempted.

◆ RegisterMetaData()

static void RegisterMetaData ( Type type )

static

Registers the metadata for a given type. This method checks if the type has an override for the "ReplicateTo" method and stores this information in the metadata. If the metadata for the type already exists, this method does nothing.

Parameters

type	The type for which to register the metadata.

◆ RegisterRpcInvokeDelegates()

static void RegisterRpcInvokeDelegates ( Type type )

static

Registers the RPC (Remote Procedure Call) invoke delegates for a given type. This method is only available when the FUSION_UNITY compilation symbol is defined.

Parameters

type	The type for which to register the RPC invoke delegates.

Exceptions

System.ArgumentException	Thrown when the provided type is not a subclass of NetworkBehaviour.
System.InvalidOperationException	Thrown when the provided type does not have a weaved attribute or its word count is negative.

◆ ShouldRegisterRpcInvokeDelegates()

static bool ShouldRegisterRpcInvokeDelegates ( Type type )

static

Determines whether the RPC (Remote Procedure Call) invoke delegates should be registered for a given type.

Parameters

type	The type for which to check the registration of RPC invoke delegates.

Returns: True if the RPC invoke delegates should be registered for the type, false otherwise.

◆ ThrowIfBehaviourNotInitialized()

static void ThrowIfBehaviourNotInitialized ( NetworkBehaviour behaviour )

static

Checks if the NetworkBehaviour object is initialized and throws an exception if it is not.

Parameters

behaviour The NetworkBehaviour object to check.

Exceptions

System.InvalidOperationException Thrown when the NetworkBehaviour object is not initialized.

◆ TryGetRpcInvokeDelegateArray()

static bool TryGetRpcInvokeDelegateArray	(	Type	type,
		out RpcInvokeData[]	delegates
	)

static

Tries to get the RPC (Remote Procedure Call) invoke delegate array for a given type.

Parameters

type	The type for which to get the RPC invoke delegate array.
delegates	When this method returns, contains the RPC invoke delegate array if the type has one; otherwise, null.

Returns: true if the type has an RPC invoke delegate array; otherwise, false.

◆ TryGetRpcStaticInvokeDelegate()

static bool TryGetRpcStaticInvokeDelegate	(	int	index,
		out RpcStaticInvokeDelegate	del
	)

static

Tries to get the static RPC (Remote Procedure Call) invoke delegate based on its index.

Parameters

index	The index of the static RPC.
del	When this method returns, contains the static RPC invoke delegate if it exists; otherwise, default.

Returns: True if the static RPC invoke delegate exists; otherwise, false.

Photon Fusion 2.0.0

Classes

Static Public Member Functions

Static Public Attributes

Detailed Description

Member Function Documentation

◆ CloneArray< T >()

◆ CopyFromNetworkArray< T >()

◆ CopyFromNetworkDictionary< D, K, V >()

◆ CopyFromNetworkList< T >()

◆ GetMetaData()

◆ GetRpcStaticIndexOrThrow()

◆ GetStaticWordCount()

◆ GetWordCount()

◆ HasStaticWordCount()

◆ InitializeNetworkArray< T >()

◆ InitializeNetworkDictionary< D, K, V >()

◆ InitializeNetworkList< T >()

◆ InternalOnDestroy()

◆ InternalOnDisable()

◆ InternalOnEnable()

◆ MakeSerializableDictionary< K, V >()

◆ NotifyLocalSimulationNotAllowedToSendRpc()

◆ NotifyLocalTargetedRpcCulled()

◆ NotifyNetworkUnwrapFailed< T >()

◆ NotifyNetworkWrapFailed< T >() [1/2]

◆ NotifyNetworkWrapFailed< T >() [2/2]

◆ NotifyRpcPayloadSizeExceeded()

◆ NotifyRpcTargetUnreachable()

◆ RegisterMetaData()

◆ RegisterRpcInvokeDelegates()

◆ ShouldRegisterRpcInvokeDelegates()

◆ ThrowIfBehaviourNotInitialized()

◆ TryGetRpcInvokeDelegateArray()

◆ TryGetRpcStaticInvokeDelegate()