Click or drag to resize

GameObjectPoolSettings Properties

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

The GameObjectPoolSettings type exposes the following members.

Properties
  NameDescription
Public propertyStatic memberDefaultSettings
Gets the default settings.
Public propertyDontDestroyOnLoad
Gets or sets a value indicating whether the pool should persist between scene changes.
(Inherited from SharedPoolSettings<TSource>.)
Public propertyEnabled
Gets or sets a value indicating whether pooling is enabled.
(Inherited from SharedPoolSettings<TSource>.)
Public propertyFrozen
Gets a value indicating whether the object has been frozen, and cannot be modified.
(Inherited from SharedPoolSettings<TSource>.)
Public propertyInitialiseOnStart
Gets or sets a value indicating whether to initialise the pool in the MonoBehaviour Start method.
(Inherited from SharedPoolSettings<TSource>.)
Public propertyInitialSize
Gets or sets the initial size of the pool.
(Inherited from SharedPoolSettings<TSource>.)
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 SharedPoolSettings<TSource>.)
Public propertyLogMessages
Gets or sets the level of log messaging that the pool will output.
(Inherited from SharedPoolSettings<TSource>.)
Public propertyMaximumSize
Gets or sets the maximum size of the pool, which is the maximum number of objects it can contain.
(Inherited from SharedPoolSettings<TSource>.)
Public propertyNotificationMode
Gets or sets the modes in which pooled objects are notified of their acquisition from, and release to, the pool.
(Inherited from SharedPoolSettings<TSource>.)
Public propertyRecordStatistics
Gets or sets a value indicating whether to record pool statistics.
(Inherited from SharedPoolSettings<TSource>.)
Public propertyReparentPooledObjects
Gets or sets a value indicating whether to re-parent the pooled objects to the pool's transform, after the objects are released.
(Inherited from SharedPoolSettings<TSource>.)
Public propertySource
Gets or sets the game object that the pool will be used for.
(Overrides SharedPoolSettings<TSource>.Source.)
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).
(Inherited from SharedPoolSettings<TSource>.)
Top
See Also