Click or drag to resize

ComponentPool Methods

[This is preliminary documentation and is subject to change.]

The ComponentPool type exposes the following members.

Methods
  NameDescription
Public methodAcquire
Acquires an instance of the component.
(Overrides PoolBaseTSource, TInstance, TSettingsAcquire.)
Public methodAcquire(Transform)
Acquires an instance of the component, and sets the parent transform of its GameObject.
Public methodAcquire(Vector3, Quaternion)
Acquires an instance of the component, and sets the position and rotation of its GameObject.
Public methodAcquire(Transform, Vector3, Quaternion)
Acquires an instance of the component, and sets the parent transform, position and rotation of its GameObject.
Public methodAcquireT
Acquires an instance of the component.
Public methodAcquireT(Transform)
Acquires an instance of the component, and sets the parent transform of its GameObject.
Public methodAcquireT(Vector3, Quaternion)
Acquires an instance of the component, and sets the position and rotation of its GameObject.
Public methodAcquireT(Transform, Vector3, Quaternion)
Acquires an instance of the component, and sets the parent transform, position and rotation of its GameObject.
Protected methodCanInitialise
When overridden in a derived class, determines whether the pool can be initialised.
(Overrides PoolBaseTSource, TInstance, TSettingsCanInitialise.)
Public methodClear
Clears the pool, emptying it of all pooled objects.
(Inherited from PoolBaseTSource, TInstance, TSettings.)
Protected methodCreateInternalPool
When implemented in a derived class, creates the internal object pool.
(Overrides PoolBaseTSource, TInstance, TSettingsCreateInternalPool.)
Protected methodCreateSettingsClone
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).)
Protected methodDestroyInstance
When implemented in a derived class, destroys the specified instance.
(Overrides PoolBaseTSource, TInstance, TSettingsDestroyInstance(TInstance).)
Public methodEquals (Inherited from Object.)
Public methodFill
Fills the pool, populating it with pooled objects until it reaches the maximum pool size.
(Inherited from PoolBaseTSource, TInstance, TSettings.)
Protected methodFinalize (Inherited from Object.)
Public methodGetHashCode (Inherited from Object.)
Public methodGetItems (Inherited from PoolBaseTSource, TInstance, TSettings.)
Public methodGetType (Inherited from Object.)
Public methodGrow
Increases the number of objects contained by the pool by the specified amount.
(Inherited from PoolBaseTSource, TInstance, TSettings.)
Public methodInitialise
Initialises the pool, populating it with the initial number of objects.
(Overrides PoolBaseTSource, TInstance, TSettingsInitialise.)
Public methodInitialise(TSettings)
Initialises the pool, populating it with the initial number of objects.
(Inherited from PoolBaseTSource, TInstance, TSettings.)
Protected methodMemberwiseClone (Inherited from Object.)
Protected methodOnCanAcquireChanged
Raises the CanAcquireChanged event.
(Inherited from PoolBaseTSource, TInstance, TSettings.)
Protected methodOnCountChanged
Raises the CountChanged event.
(Inherited from PoolBaseTSource, TInstance, TSettings.)
Protected methodOnDestroy (Overrides PoolBaseTSource, TInstance, TSettingsOnDestroy.)
Protected methodOnDestroyed
Raises the Destroyed event.
(Inherited from PoolBaseTSource, TInstance, TSettings.)
Protected methodOnInitialised
Raises the Initialised event.
(Inherited from PoolBaseTSource, TInstance, TSettings.)
Protected methodOnObjectAcquired
Raises the ObjectAcquired event.
(Overrides PoolBaseTSource, TInstance, TSettingsOnObjectAcquired(TInstance, Boolean).)
Protected methodOnObjectDestroyed
Raises the ObjectDestroyed event.
(Overrides PoolBaseTSource, TInstance, TSettingsOnObjectDestroyed(TInstance).)
Protected methodOnObjectInstantiated
Raises the ObjectInstantiated event.
(Overrides PoolBaseTSource, TInstance, TSettingsOnObjectInstantiated(TInstance).)
Protected methodOnObjectReleased
Raises the ObjectReleased event.
(Overrides PoolBaseTSource, TInstance, TSettingsOnObjectReleased(TInstance, Boolean).)
Public methodRelease
Releases an instance back to the pool.
(Inherited from PoolBaseTSource, TInstance, TSettings.)
Public methodSetSize
Sets the number of objects contained by the pool, either destroying excess pooled objects, or instantiating new ones.
(Inherited from PoolBaseTSource, TInstance, TSettings.)
Public methodShrink
Decreases the number of objects contained by the pool by the specified amount.
(Inherited from PoolBaseTSource, TInstance, TSettings.)
Protected methodStart (Inherited from PoolBaseTSource, TInstance, TSettings.)
Public methodToString (Inherited from Object.)
Public methodTryAcquire(Component)
Acquires an instance of the component.
(Overrides PoolBaseTSource, TInstance, TSettingsTryAcquire(TInstance).)
Public methodTryAcquire(Transform, Component)
Acquires an instance of the component, and sets the parent transform of its GameObject.
Public methodTryAcquire(Vector3, Quaternion, Component)
Acquires an instance of the component, and sets the position and rotation of its GameObject.
Public methodTryAcquire(Transform, Vector3, Quaternion, Component)
Acquires an instance of the component, and sets the parent transform, position and rotation of its GameObject.
Public methodTryAcquireT(T)
Acquires an instance of the component.
Public methodTryAcquireT(Transform, T)
Acquires an instance of the component, and sets the parent transform of its GameObject.
Public methodTryAcquireT(Vector3, Quaternion, T)
Acquires an instance of the component, and sets the position and rotation of its GameObject.
Public methodTryAcquireT(Transform, Vector3, Quaternion, T)
Acquires an instance of the component, and sets the parent transform, position and rotation of its GameObject.
Top
See Also