Class NetworkPrefabHandler
Primary handler to add or remove customized spawn and destroy handlers for a network prefab (i.e. a prefab with a NetworkObject component) Register custom prefab handlers by implementing the INetworkPrefabInstanceHandler interface.
Inherited Members
Namespace: Unity.Netcode
Assembly: solution.dll
Syntax
public class NetworkPrefabHandler
Methods
Name | Description |
---|---|
AddHandler(uint, INetworkPrefabInstanceHandler) | Use a GlobalObjectIdHash to register a class that implements the INetworkPrefabInstanceHandler interface with the NetworkPrefabHandler |
AddHandler(NetworkObject, INetworkPrefabInstanceHandler) | Use a NetworkObject to register a class that implements the INetworkPrefabInstanceHandler interface with the NetworkPrefabHandler |
AddHandler(GameObject, INetworkPrefabInstanceHandler) | Use a GameObject to register a class that implements the INetworkPrefabInstanceHandler interface with the NetworkPrefabHandler |
AddNetworkPrefab(GameObject) | Adds a new prefab to the network prefab list. This can be any GameObject with a NetworkObject component, from any source (addressables, asset bundles, Resource.Load, dynamically created, etc) There are three limitations to this method:
|
GetNetworkPrefabOverride(GameObject) | Returns the GameObject to use as the override as could be defined within the NetworkPrefab list Note: This should be used to create GameObject pools (with NetworkObject components) under the scenario where you are using the Host model as it spawns everything locally. As such, the override will not be applied when spawning locally on a Host. Related Classes and Interfaces: INetworkPrefabInstanceHandler |
RegisterHostGlobalObjectIdHashValues(GameObject, List<GameObject>) | HOST ONLY! Since a host is unique and is considered both a client and a server, for each source NetworkPrefab you must manually register all potential GameObject target overrides that have the NetworkObject component. |
RemoveHandler(uint) | Use the GlobalObjectIdHash of the overridden network prefab asset to remove a registered class that implements the INetworkPrefabInstanceHandler interface. |
RemoveHandler(NetworkObject) | Use the NetworkObject of the overridden network prefab asset to remove a registered class that implements the INetworkPrefabInstanceHandler interface. |
RemoveHandler(GameObject) | Use the GameObject of the overridden network prefab asset to remove a registered class that implements the INetworkPrefabInstanceHandler interface. |
RemoveNetworkPrefab(GameObject) | Remove a prefab from the prefab list. As with AddNetworkPrefab, this is specific to the client it's called on - calling it on the server does not automatically remove anything on any of the client processes. Like AddNetworkPrefab, when NetworkConfig.ForceSamePrefabs is enabled, this cannot be called after connecting. |