ComponentPool Properties |
[This is preliminary documentation and is subject to change.]
The ComponentPool type exposes the following members.
| Name | Description | |
|---|---|---|
| AdditionalComponentTypes |
Gets a collection of additional component types that should exist on the pooled object.
| |
| 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.
(Inherited from PoolBaseTSource, TInstance, TSettings.) | |
| Definition |
Gets the settings that were used to initialise this pool.
(Inherited from PoolBaseTSource, TInstance, TSettings.) | |
| DontDestroyOnLoad |
Gets or sets a value indicating whether the pool should persist between scene changes.
(Inherited from PoolBaseTSource, TInstance, TSettings.) | |
| Enabled |
Gets or sets a value indicating whether pooling is enabled.
(Inherited from PoolBaseTSource, TInstance, TSettings.) | |
| 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.
(Inherited from PoolBaseTSource, TInstance, TSettings.) | |
| InitialSize |
Gets or sets the initial size of the pool.
Cannot be set once the pool has been initialised.
(Inherited from PoolBaseTSource, TInstance, TSettings.) | |
| 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.
(Inherited from PoolBaseTSource, TInstance, TSettings.) | |
| IsEmpty |
Gets a value indicating whether the pool is empty and contains no objects.
(Inherited from PoolBaseTSource, TInstance, TSettings.) | |
| IsInitialised |
Gets a value indicating whether the pool has been initialised.
(Inherited from PoolBaseTSource, TInstance, TSettings.) | |
| Items |
Gets a list of items currently contained by the pool.
(Inherited from PoolBaseTSource, TInstance, TSettings.) | |
| LogMessages |
Gets or sets the level of log messaging that the pool will output.
(Inherited from PoolBaseTSource, TInstance, TSettings.) | |
| MaximumSize |
Gets or sets the maximum size of the pool, which is the maximum number of objects it can contain.
(Inherited from PoolBaseTSource, TInstance, TSettings.) | |
| NotificationMode |
Gets or sets the modes in which pooled objects are notified of their acquisition from, and release to, the pool.
(Overrides PoolBaseTSource, TInstance, TSettingsNotificationMode.) | |
| Pool |
When implemented in a derived class, gets or sets the internal object pool.
(Overrides PoolBaseTSource, TInstance, TSettingsPool.) | |
| RecordStatistics |
Gets or sets a value indicating whether to record pool statistics.
(Inherited from PoolBaseTSource, TInstance, TSettings.) | |
| 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.
(Overrides PoolBaseTSource, TInstance, TSettingsReparentPooledObjects.) | |
| Source |
Gets or sets the source object that will be pooled.
(Inherited from PoolBaseTSource, TInstance, TSettings.) | |
| Statistics |
Gets an object containing general operational statistics about the pool.
(Inherited from PoolBaseTSource, TInstance, TSettings.) | |
| 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).
(Overrides PoolBaseTSource, TInstance, TSettingsWarnOnDestroy.) |