Click or drag to resize

SerialisableGenericComponentPool<T> Properties

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

The SerialisableGenericComponentPool< T> generic type exposes the following members.

Properties
  NameDescription
Public propertyAdditionalComponentTypes
Gets a list of additional component types, that should be added to the same GameObject as the main component type.
Public propertyCanAcquire

Gets a value indicating whether an instance can be acquired from the pool.

An instance can be acquired when the pool contains at least one instance, or when InstantiateWhenEmpty is true.

(Inherited from SerialisableObjectPool<T>.)
Public propertyComponentType
Gets the type of the component being pooled.
Public propertyCount
Gets the number of objects currently contained by the pool.
(Inherited from SerialisableObjectPool<T>.)
Public propertyInitialSize
Gets or sets the initial size of the pool. Cannot be set once the pool has been initialised.
(Inherited from SerialisableObjectPool<T>.)
Public propertyInstantiateWhenEmpty
Gets or sets a value indicating whether to instantiate a new object when the pool is empty, and an attempt is made to acquire from the pool.
(Inherited from SerialisableObjectPool<T>.)
Public propertyIsEmpty
Gets a value indicating whether the pool is empty and contains no objects.
(Inherited from SerialisableObjectPool<T>.)
Public propertyIsFull
Gets a value indicating whether the pool is full, and cannot contain any more objects.
(Inherited from SerialisableObjectPool<T>.)
Public propertyIsInitialised
Gets a value indicating whether the pool has been initialised.
(Inherited from SerialisableObjectPool<T>.)
Public propertyItems
Gets a list of items currently contained by the pool.
(Inherited from SerialisableObjectPool<T>.)
Public propertyLogMessages
Gets or sets the level of log messaging that the pool will output.
(Inherited from SerialisableObjectPool<T>.)
Public propertyMaximumSize
Gets or sets the maximum size of the pool, which is the maximum number of objects it can contain.
(Inherited from SerialisableObjectPool<T>.)
Public propertyNotificationMode
Gets or sets the way in which pooled objects are notified about being acquired from, and returned to, the pool. Cannot be set once the pool has been initialised.
Public propertyParent
Gets or sets the parent transform to which all pooled objects will be parented in the hierarchy, if ReparentPooledObjects is true.
Public propertyRecordStatistics
Gets or sets a value indicating whether to record pool statistics.
(Inherited from SerialisableObjectPool<T>.)
Protected propertyRefillPoolOnReinitialise
Gets a value indiciating whether to refill the pool with new components after the pool is reinitialised, as happens from deserialisation.
(Overrides SerialisableObjectPool<T>.RefillPoolOnReinitialise.)
Public propertyReparentPooledObjects
Gets or sets a value indicating whether to re-parent the pooled objects to the Parent transform, after the objects are returned to the pool.
Public propertyStatistics
Gets an object containing general operational statistics about the pool.
(Inherited from SerialisableObjectPool<T>.)
Public propertyWarnOnDestroy
Gets or sets a value indicating whether to log a warning message when a poolable object is destroyed (either inside of the pool, or while in use).
Top
See Also