Click or drag to resize

SerialisableComponentPool Methods

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

The SerialisableComponentPool type exposes the following members.

Methods
  NameDescription
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 methodCheckTypeT
A conditionally-compiled helper method that checks if the type T is assignable from ComponentType.
Public methodClear
Clears the pool, emptying it of all pooled objects.
(Inherited from SerialisableObjectPoolT.)
Public methodContains
Determines whether an instance is in the pool.
(Inherited from SerialisableObjectPoolT.)
Public methodEquals (Inherited from Object.)
Public methodFill
Fills the pool, populating it with pooled objects until it reaches the maximum pool size.
(Inherited from SerialisableObjectPoolT.)
Protected methodFinalize (Inherited from Object.)
Public methodGetHashCode (Inherited from Object.)
Public methodGetItems (Inherited from SerialisableObjectPoolT.)
Protected methodGetObjectFactory
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 SerialisableGenericComponentPoolT.)
Public methodGetType (Inherited from Object.)
Public methodInitialise
Initialises the pool, populating it with objects and making it ready for use.
(Inherited from SerialisableObjectPoolT.)
Protected methodInitialise(Boolean)
Initialises the pool, making it ready for use, and optionally populating it with objects.
(Inherited from SerialisableObjectPoolT.)
Protected methodMemberwiseClone (Inherited from Object.)
Protected methodOnAfterDeserialize
Performs actions after the object has been deserialised.
(Inherited from SerialisableGenericComponentPoolT.)
Protected methodOnBeforeSerialize
Performs actions prior to the object being serialised.
(Inherited from SerialisableGenericComponentPoolT.)
Protected methodOnCanAcquireChanged
Raises the CanAcquireChanged event.
(Inherited from SerialisableObjectPoolT.)
Protected methodOnCountChanged
Raises the CountChanged event.
(Inherited from SerialisableObjectPoolT.)
Protected methodOnInitialised
Raises the Initialised event.
(Inherited from SerialisableObjectPoolT.)
Protected methodOnObjectAcquired
Raises the ObjectAcquired event.
(Inherited from SerialisableGenericComponentPoolT.)
Protected methodOnObjectDestroyed
Raises the ObjectDestroyed event.
(Inherited from SerialisableGenericComponentPoolT.)
Protected methodOnObjectInstantiated
Raises the ObjectInstantiated event.
(Inherited from SerialisableObjectPoolT.)
Protected methodOnObjectReleased
Raises the ObjectReleased event.
(Inherited from SerialisableGenericComponentPoolT.)
Public methodRelease
Releases an object back to the pool.
(Inherited from SerialisableObjectPoolT.)
Protected methodReleaseInternal
Releases an object back to the pool.
(Inherited from SerialisableGenericComponentPoolT.)
Public methodRemove
Removes the specified instance from the pool.
(Inherited from SerialisableObjectPoolT.)
Public methodSetSize
Sets the number of objects contained by the pool, either destroying excess pooled objects, or instantiating new ones.
(Inherited from SerialisableObjectPoolT.)
Public methodToString (Inherited from Object.)
Public methodTryAcquire(T)
Acquires an object from the pool.
(Inherited from SerialisableObjectPoolT.)
Public methodTryAcquire(Transform, T)
Acquires an instance of the component, and sets the parent transform of its GameObject.
(Inherited from SerialisableGenericComponentPoolT.)
Public methodTryAcquire(Vector3, Quaternion, T)
Acquires an instance of the component, and sets the position and rotation of its GameObject.
(Inherited from SerialisableGenericComponentPoolT.)
Public methodTryAcquire(Transform, Vector3, Quaternion, T)
Acquires an instance of the component, and sets the parent transform, position and rotation of its GameObject.
(Inherited from SerialisableGenericComponentPoolT.)
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