Legacy Documentation: Version 2017.1 (Go to current version)
LanguageEnglish
  • C#
  • JS

Script language

Select your preferred scripting language. All code snippets will be displayed in this language.

ClientScene.RegisterPrefab

Suggest a change

Success!

Thank you for helping us improve the quality of Unity Documentation. Although we cannot accept all submissions, we do read each suggested change from our users and will make updates where applicable.

Close

Submission failed

For some reason your suggested change could not be submitted. Please <a>try again</a> in a few minutes. And thank you for taking the time to help us improve the quality of Unity Documentation.

Close

Cancel

public static function RegisterPrefab(prefab: GameObject): void;
public static void RegisterPrefab(GameObject prefab);
public static function RegisterPrefab(prefab: GameObject, spawnHandler: Networking.SpawnDelegate, unspawnHandler: Networking.UnSpawnDelegate): void;
public static void RegisterPrefab(GameObject prefab, Networking.SpawnDelegate spawnHandler, Networking.UnSpawnDelegate unspawnHandler);
public static function RegisterPrefab(prefab: GameObject, newAssetId: Networking.NetworkHash128): void;
public static void RegisterPrefab(GameObject prefab, Networking.NetworkHash128 newAssetId);

Parameters

prefab A Prefab that will be spawned.
spawnHandler A method to use as a custom spawnhandler on clients.
unspawnHandler A method to use as a custom un-spawnhandler on clients.
newAssetId An assetId to be assigned to this prefab. This allows a dynamically created game object to be registered for an already known asset Id.

Description

Registers a prefab with the UNET spawning system.

When a NetworkIdentity object is spawned on a server with NetworkServer.SpawnObject(), and the prefab that the object was created from was registered with RegisterPrefab(), the client will use that prefab to instantiate a corresponding client object with the same netId.

The NetworkManager has a list of spawnable prefabs, it uses this function to register those prefabs with the ClientScene.

The set of current spawnable object is available in the ClientScene static member variable ClientScene.prefabs, which is a dictionary of NetworkAssetIds and prefab references.

no example available in JavaScript
using UnityEngine;
using UnityEngine.Networking;

public class PlantSpawner : NetworkBehaviour { public GameObject plantPrefab;

public override void OnStartClient() { ClientScene.RegisterPrefab(plantPrefab); }

[Server] public void ServerSpawnPlant(Vector3 pos, Quaternion rot) { var plant = (GameObject)Instantiate(plantPrefab, pos, rot); NetworkServer.Spawn(plant); } }

The optional custom spawn and un-spawn handler functions can be used to implement more advanced spawning strategies such as pbject pools.

Did you find this page useful? Please give it a rating:

Copyright © 2023 Unity Technologies
优美缔软件(上海)有限公司 版权所有
"Unity"、Unity 徽标及其他 Unity 商标是 Unity Technologies 或其附属机构在美国及其他地区的商标或注册商标。其他名称或品牌是其各自所有者的商标。
公安部备案号:
31010902002961