PoolBaseTSource, TInstance, TSettings Properties |
[This is preliminary documentation and is subject to change.]
The PoolBaseTSource, TInstance, TSettings generic type exposes the following members.
Properties| Name | Description | |
|---|---|---|
 | CanAcquire | 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 . |
| Count |
Gets the number of objects currently contained by the pool.
|
| Definition |
Gets the settings that were used to initialise this pool.
|
| DontDestroyOnLoad |
Gets or sets a value indicating whether the pool should persist between scene changes.
|
| Enabled |
Gets or sets a value indicating whether pooling is enabled.
|
| InitialiseOnStart |
Gets or sets a value indicating whether to initialise the pool in the MonoBehaviour Start method.
Cannot be set once the pool has been initialised.
|
| InitialSize |
Gets or sets the initial size of the pool.
Cannot be set once the pool has been initialised.
|
| InstantiateWhenEmpty |
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.
|
| IsEmpty |
Gets a value indicating whether the pool is empty and contains no objects.
|
| IsInitialised |
Gets a value indicating whether the pool has been initialised.
|
| Items |
Gets a list of items currently contained by the pool.
|
| LogMessages |
Gets or sets the level of log messaging that the pool will output.
|
| MaximumSize |
Gets or sets the maximum size of the pool, which is the maximum number of objects it can contain.
|
| NotificationMode |
Gets or sets the modes in which pooled objects are notified of their acquisition from, and release to, the pool.
|
 | Pool |
When implemented in a derived class, gets or sets the internal object pool.
|
| RecordStatistics |
Gets or sets a value indicating whether to record pool statistics.
|
| ReparentPooledObjects |
Gets or sets a value indicating whether to re-parent the pooled objects to the pool's Transform,
after the objects are returned to the pool.
|
| Source |
Gets or sets the source object that will be pooled.
|
| Statistics |
Gets an object containing general operational statistics about the pool.
|
| WarnOnDestroy |
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).
|
See Also