SerialisableComponentPool Methods |
[This is preliminary documentation and is subject to change.]
The SerialisableComponentPool type exposes the following members.
Methods| Name | Description | |
|---|---|---|
 | Acquire<T>() |
Acquires an instance of the component.
|
| Acquire<T>(Transform) |
Acquires an instance of the component, and sets the parent transform of its GameObject.
|
| Acquire<T>(Vector3, Quaternion) |
Acquires an instance of the component, and sets the position and rotation of its GameObject.
|
| Acquire<T>(Transform, Vector3, Quaternion) |
Acquires an instance of the component, and sets the parent transform, position and rotation of its GameObject.
|
 | CheckType<T> |
A conditionally-compiled helper method that checks if the type T is assignable from ComponentType.
|
| Clear |
Clears the pool, emptying it of all pooled objects.
(Inherited from SerialisableObjectPool<T>.) |
| Contains |
Determines whether an instance is in the pool.
(Inherited from SerialisableObjectPool<T>.) |
| Equals | (Inherited from Object.) |
| Fill |
Fills the pool, populating it with pooled objects until it reaches the maximum pool size.
(Inherited from SerialisableObjectPool<T>.) |
| 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 List<T>.
(Inherited from SerialisableObjectPool<T>.) |
| GetObjectFactory |
Gets a function used to create new instances of the pooled type.
By default, this method uses the public parameterless constructor of type T.
This method should be overridden in a subclass if different behaviour is required.
(Inherited from SerialisableGenericComponentPool<T>.) |
| GetType | (Inherited from Object.) |
| Initialise() |
Initialises the pool, populating it with objects and making it ready for use.
(Inherited from SerialisableObjectPool<T>.) |
| Initialise(Boolean) |
Initialises the pool, making it ready for use, and optionally populating it with objects.
(Inherited from SerialisableObjectPool<T>.) |
| MemberwiseClone | (Inherited from Object.) |
| OnAfterDeserialize |
Performs actions after the object has been deserialised.
(Inherited from SerialisableGenericComponentPool<T>.) |
| OnBeforeSerialize |
Performs actions prior to the object being serialised.
(Inherited from SerialisableGenericComponentPool<T>.) |
| OnCanAcquireChanged |
Raises the CanAcquireChanged event.
(Inherited from SerialisableObjectPool<T>.) |
| OnCountChanged |
Raises the CountChanged event.
(Inherited from SerialisableObjectPool<T>.) |
| OnInitialised |
Raises the Initialised event.
(Inherited from SerialisableObjectPool<T>.) |
| OnObjectAcquired |
Raises the ObjectAcquired event.
(Inherited from SerialisableGenericComponentPool<T>.) |
| OnObjectDestroyed |
Raises the ObjectDestroyed event.
(Inherited from SerialisableGenericComponentPool<T>.) |
| OnObjectInstantiated |
Raises the ObjectInstantiated event.
(Inherited from SerialisableObjectPool<T>.) |
| OnObjectReleased |
Raises the ObjectReleased event.
(Inherited from SerialisableGenericComponentPool<T>.) |
| Release |
Releases an object back to the pool.
(Inherited from SerialisableObjectPool<T>.) |
| ReleaseInternal |
Releases an object back to the pool.
(Inherited from SerialisableGenericComponentPool<T>.) |
| Remove |
Removes the specified instance from the pool.
(Inherited from SerialisableObjectPool<T>.) |
| SetSize |
Sets the number of objects contained by the pool, either destroying excess pooled objects, or instantiating new ones.
(Inherited from SerialisableObjectPool<T>.) |
| ToString | (Inherited from Object.) |
| TryAcquire(T) |
Acquires an object from the pool.
(Inherited from SerialisableObjectPool<T>.) |
| TryAcquire(Transform, T) |
Acquires an instance of the component, and sets the parent transform of its GameObject.
(Inherited from SerialisableGenericComponentPool<T>.) |
| TryAcquire(Vector3, Quaternion, T) |
Acquires an instance of the component, and sets the position and rotation of its GameObject.
(Inherited from SerialisableGenericComponentPool<T>.) |
| TryAcquire(Transform, Vector3, Quaternion, T) |
Acquires an instance of the component, and sets the parent transform, position and rotation of its GameObject.
(Inherited from SerialisableGenericComponentPool<T>.) |
| TryAcquire<T>(T) |
Acquires an instance of the component.
|
| TryAcquire<T>(Transform, T) |
Acquires an instance of the component, and sets the parent transform of its GameObject.
|
| TryAcquire<T>(Vector3, Quaternion, T) |
Acquires an instance of the component, and sets the position and rotation of its GameObject.
|
| TryAcquire<T>(Transform, Vector3, Quaternion, T) |
Acquires an instance of the component, and sets the parent transform, position and rotation of its GameObject.
|
See Also