MLAPI.Spawning.NetworkSpawnManager

Class that handles object spawning

Inheritance#

System.Dynamic.ExpandoObject

Inherited Members#

Object.Equals(Object)

Object.Equals(Object, Object)

Object.GetHashCode()

Object.GetType()

Object.MemberwiseClone()

Object.ReferenceEquals(Object, Object)

Object.ToString()

Namespace: System.Dynamic.ExpandoObject#

Assembly: MLAPI.dll#

Syntax#

public static class NetworkSpawnManager

Fields#

SpawnedObjects#

The currently spawned objects

Declaration#

public static readonly Dictionary<ulong, NetworkObject> SpawnedObjects

Field Value#

Type	Description
System.Collections.Generic.Dictionary<System.UInt64, NetworkObject>

SpawnedObjectsList#

A list of the spawned objects

Declaration#

public static readonly HashSet<NetworkObject> SpawnedObjectsList

Field Value#

Type	Description
System.Collections.Generic.HashSet<NetworkObject>

Methods#

GetLocalPlayerObject()#

Returns the local player object or null if one does not exist

Declaration#

public static NetworkObject GetLocalPlayerObject()

Returns#

Type	Description
NetworkObject	The local player object or null if one does not exist

GetNetworkPrefabIndexOfHash(UInt64)#

Gets the prefab index of a given prefab hash

Declaration#

public static int GetNetworkPrefabIndexOfHash(ulong hash)

Parameters#

Type	Name	Description
System.UInt64	hash	The hash of the prefab

Returns#

Type	Description
System.Int32	The index of the prefab

GetPlayerNetworkObject(UInt64)#

Returns the player object with a given clientId or null if one does not exist

Declaration#

public static NetworkObject GetPlayerNetworkObject(ulong clientId)

Parameters#

Type	Name	Description
System.UInt64	clientId

Returns#

Type	Description
NetworkObject	The player object with a given clientId or null if one does not exist

GetPrefabHashFromGenerator(String)#

Returns the prefab hash for a given prefab hash generator

Declaration#

public static ulong GetPrefabHashFromGenerator(string generator)

Parameters#

Type	Name	Description
System.String	generator	The prefab hash generator

Returns#

Type	Description
System.UInt64	The hash for the given generator

GetPrefabHashFromIndex(Int32)#

Returns the prefab hash for the NetworkPrefab with a given index

Declaration#

public static ulong GetPrefabHashFromIndex(int index)

Parameters#

Type	Name	Description
System.Int32	index	The NetworkPrefab index

Returns#

Type	Description
System.UInt64	The prefab hash for the given prefab index

RegisterDestroyHandler(UInt64, NetworkSpawnManager.DestroyHandlerDelegate)#

Registers a delegate for destroying NetworkObjects, useful for object pooling

Declaration#

public static void RegisterDestroyHandler(ulong prefabHash, NetworkSpawnManager.DestroyHandlerDelegate handler)

Parameters#

Type	Name	Description
System.UInt64	prefabHash	The prefab hash to destroy
NetworkSpawnManager.DestroyHandlerDelegate	handler	The delegate handler

RegisterSpawnHandler(UInt64, NetworkSpawnManager.SpawnHandlerDelegate)#

Registers a delegate for spawning NetworkPrefabs, useful for object pooling

Declaration#

public static void RegisterSpawnHandler(ulong prefabHash, NetworkSpawnManager.SpawnHandlerDelegate handler)

Parameters#

Type	Name	Description
System.UInt64	prefabHash	The prefab hash to spawn
NetworkSpawnManager.SpawnHandlerDelegate	handler	The delegate handler

UnregisterDestroyHandler(UInt64)#

Unregisters the custom destroy handler for a specific prefab hash

Declaration#

public static void UnregisterDestroyHandler(ulong prefabHash)

Parameters#

Type	Name	Description
System.UInt64	prefabHash	The prefab hash of the prefab destroy handler that is to be removed

UnregisterSpawnHandler(UInt64)#

Unregisters the custom spawn handler for a specific prefab hash

Declaration#

public static void UnregisterSpawnHandler(ulong prefabHash)

Parameters#

Type	Name	Description
System.UInt64	prefabHash	The prefab hash of the prefab spawn handler that is to be removed