 |
Photon Unity Networking 2
2.12
|
Defines an interface for object pooling, used in PhotonNetwork.Instantiate and PhotonNetwork.Destroy. More...
Inherited by DefaultPool.
Public Member Functions | |
| GameObject | Instantiate (string prefabId, Vector3 position, Quaternion rotation) |
| Called to get an instance of a prefab. Must return valid, disabled GameObject with PhotonView. More... | |
| void | Destroy (GameObject gameObject) |
| Called to destroy (or just return) the instance of a prefab. It's disabled and the pool may reset and cache it for later use in Instantiate. More... | |
Detailed Description
Defines an interface for object pooling, used in PhotonNetwork.Instantiate and PhotonNetwork.Destroy.
To apply your custom IPunPrefabPool, set PhotonNetwork.PrefabPool.
The pool has to return a valid, disabled GameObject when PUN calls Instantiate. Also, the position and rotation must be applied.
Note that Awake and Start are only called once by Unity, so scripts on re-used GameObjects should make use of OnEnable and or OnDisable. When OnEnable gets called, the PhotonView is already updated to the new values.
To be able to enable a GameObject, Instantiate must return an inactive object.
Before PUN "destroys" GameObjects, it will disable them.
If a component implements IPunInstantiateMagicCallback, PUN will call OnPhotonInstantiate when the networked object gets instantiated. If no components implement this on a prefab, PUN will optimize the instantiation and no longer looks up IPunInstantiateMagicCallback via GetComponents.
Member Function Documentation
| void Destroy | ( | GameObject | gameObject | ) |
Called to destroy (or just return) the instance of a prefab. It's disabled and the pool may reset and cache it for later use in Instantiate.
A pool needs some way to find out which type of GameObject got returned via Destroy(). It could be a tag, name, a component or anything similar.
- Parameters
-
gameObject The instance to destroy.
Implemented in DefaultPool.
| GameObject Instantiate | ( | string | prefabId, |
| Vector3 | position, | ||
| Quaternion | rotation | ||
| ) |
Called to get an instance of a prefab. Must return valid, disabled GameObject with PhotonView.
- Parameters
-
prefabId The id of this prefab. position The position for the instance. rotation The rotation for the instance.
- Returns
- A disabled instance to use by PUN or null if the prefabId is unknown.
Implemented in DefaultPool.