SerialisableGameObjectPool Properties |
[This is preliminary documentation and is subject to change.]
The SerialisableGameObjectPool type exposes the following members.
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.
(Inherited from SerialisableObjectPoolT.) | |
InitialSize |
Gets or sets the initial size of the pool. Cannot be set once the pool has been initialised.
(Inherited from SerialisableObjectPoolT.) | |
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 SerialisableObjectPoolT.) | |
IsEmpty |
Gets a value indicating whether the pool is empty and contains no objects.
(Inherited from SerialisableObjectPoolT.) | |
IsFull |
Gets a value indicating whether the pool is full, and cannot contain any more objects.
(Inherited from SerialisableObjectPoolT.) | |
IsInitialised |
Gets a value indicating whether the pool has been initialised.
(Inherited from SerialisableObjectPoolT.) | |
Items |
Gets a list of items currently contained by the pool.
(Inherited from SerialisableObjectPoolT.) | |
LogMessages |
Gets or sets the level of log messaging that the pool will output.
(Inherited from SerialisableObjectPoolT.) | |
MaximumSize |
Gets or sets the maximum size of the pool, which is the maximum number of objects it can contain.
(Inherited from SerialisableObjectPoolT.) | |
NotificationMode |
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.
| |
Parent |
Gets or sets the parent transform to which all pooled objects will be parented in the hierarchy,
if ReparentPooledObjects is .
| |
RecordStatistics |
Gets or sets a value indicating whether to record pool statistics.
(Inherited from SerialisableObjectPoolT.) | |
RefillPoolOnReinitialise |
Gets a value indiciating whether to refill the pool with new objects after the pool is reinitialised,
as happens from deserialisation.
(Overrides SerialisableObjectPoolTRefillPoolOnReinitialise.) | |
ReparentPooledObjects |
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.
| |
SourceObject |
Gets the source object that is being pooled.
| |
Statistics |
Gets an object containing general operational statistics about the pool.
(Inherited from SerialisableObjectPoolT.) | |
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).
|