GameObjectPool Methods |
[This is preliminary documentation and is subject to change.]
The GameObjectPool type exposes the following members.
Methods| Name | Description | |
|---|---|---|
 | Acquire |
Acquires an instance from the pool.
(Inherited from PoolBaseTSource, TInstance, TSettings.) |
| Acquire(Transform) |
Acquires an instance of the source object, and sets its parent transform.
|
| Acquire(Transform, Boolean) |
Acquires an instance of the source object, and sets its parent transform.
|
| Acquire(Vector3, Quaternion) |
Acquires an instance of the source object, and sets its position and rotation.
|
| Acquire(Vector3, Quaternion, Transform) |
Acquires an instance of the source object, and sets its parent transform, position and rotation.
|
 | CanInitialise |
When overridden in a derived class, determines whether the pool can be initialised.
(Overrides PoolBaseTSource, TInstance, TSettingsCanInitialise.) |
| Clear |
Clears the pool, emptying it of all pooled objects.
(Inherited from PoolBaseTSource, TInstance, TSettings.) |
| CreateInternalPool |
When implemented in a derived class, creates the internal object pool.
(Overrides PoolBaseTSource, TInstance, TSettingsCreateInternalPool.) |
| CreateSettingsClone |
When implemented in a derived class, creates a new instance of TSettings that is an exact copy of the specified settings.
(Overrides PoolBaseTSource, TInstance, TSettingsCreateSettingsClone(TSettings).) |
| DestroyInstance |
When implemented in a derived class, destroys the specified instance.
(Overrides PoolBaseTSource, TInstance, TSettingsDestroyInstance(TInstance).) |
| Equals | (Inherited from Object.) |
| Fill |
Fills the pool, populating it with pooled objects until it reaches the maximum pool size.
(Inherited from PoolBaseTSource, TInstance, TSettings.) |
| Finalize | (Inherited from Object.) |
| GetHashCode | (Inherited from Object.) |
| GetItems |
Gets a list of items currently contained by the pool, and stores them in the specified ListT.
(Inherited from PoolBaseTSource, TInstance, TSettings.) |
| GetType | (Inherited from Object.) |
| Grow |
Increases the number of objects contained by the pool by the specified amount.
(Inherited from PoolBaseTSource, TInstance, TSettings.) |
| Initialise |
Initialises the pool, populating it with the initial number of objects.
(Overrides PoolBaseTSource, TInstance, TSettingsInitialise.) |
| Initialise(TSettings) |
Initialises the pool, populating it with the initial number of objects.
(Inherited from PoolBaseTSource, TInstance, TSettings.) |
| MemberwiseClone | (Inherited from Object.) |
| OnCanAcquireChanged |
Raises the CanAcquireChanged event.
(Inherited from PoolBaseTSource, TInstance, TSettings.) |
| OnCountChanged |
Raises the CountChanged event.
(Inherited from PoolBaseTSource, TInstance, TSettings.) |
| OnDestroy | (Overrides PoolBaseTSource, TInstance, TSettingsOnDestroy.) |
| OnDestroyed |
Raises the Destroyed event.
(Inherited from PoolBaseTSource, TInstance, TSettings.) |
| OnInitialised |
Raises the Initialised event.
(Inherited from PoolBaseTSource, TInstance, TSettings.) |
| OnObjectAcquired |
Raises the ObjectAcquired event.
(Overrides PoolBaseTSource, TInstance, TSettingsOnObjectAcquired(TInstance, Boolean).) |
| OnObjectDestroyed |
Raises the ObjectDestroyed event.
(Overrides PoolBaseTSource, TInstance, TSettingsOnObjectDestroyed(TInstance).) |
| OnObjectInstantiated |
Raises the ObjectInstantiated event.
(Overrides PoolBaseTSource, TInstance, TSettingsOnObjectInstantiated(TInstance).) |
| OnObjectReleased |
Raises the ObjectReleased event.
(Overrides PoolBaseTSource, TInstance, TSettingsOnObjectReleased(TInstance, Boolean).) |
| Release |
Releases an instance back to the pool.
(Inherited from PoolBaseTSource, TInstance, TSettings.) |
| SetSize |
Sets the number of objects contained by the pool, either destroying excess pooled objects, or instantiating new ones.
(Inherited from PoolBaseTSource, TInstance, TSettings.) |
| Shrink |
Decreases the number of objects contained by the pool by the specified amount.
(Inherited from PoolBaseTSource, TInstance, TSettings.) |
| Start | (Inherited from PoolBaseTSource, TInstance, TSettings.) |
| ToString | (Inherited from Object.) |
| TryAcquire(TInstance) |
Acquires an instance from the pool.
(Inherited from PoolBaseTSource, TInstance, TSettings.) |
| TryAcquire(Transform, GameObject) |
Acquires an instance of the source object, and sets its parent transform.
|
| TryAcquire(Transform, Boolean, GameObject) |
Acquires an instance of the source object, and sets its parent transform.
|
| TryAcquire(Vector3, Quaternion, GameObject) |
Acquires an instance of the source object, and sets its position and rotation.
|
| TryAcquire(Vector3, Quaternion, Transform, GameObject) |
Acquires an instance of the source object, and sets its parent transform, position and rotation.
|
See Also