Click or drag to resize

ComponentPoolSettings Properties

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

The ComponentPoolSettings 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 pooled component.
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 SharedPoolSettingsTSource.)
Public propertyEnabled
Gets or sets a value indicating whether pooling is enabled.
(Inherited from SharedPoolSettingsTSource.)
Public propertyFrozen
Gets a value indicating whether the object has been frozen, and cannot be modified.
(Inherited from SharedPoolSettingsTSource.)
Public propertyInitialiseOnStart
Gets or sets a value indicating whether to initialise the pool in the MonoBehaviour Start method.
(Inherited from SharedPoolSettingsTSource.)
Public propertyInitialSize
Gets or sets the initial size of the pool.
(Inherited from SharedPoolSettingsTSource.)
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 SharedPoolSettingsTSource.)
Public propertyLogMessages
Gets or sets the level of log messaging that the pool will output.
(Inherited from SharedPoolSettingsTSource.)
Public propertyMaximumSize
Gets or sets the maximum size of the pool, which is the maximum number of objects it can contain.
(Inherited from SharedPoolSettingsTSource.)
Public propertyNotificationMode
Gets or sets the modes in which pooled objects are notified of their acquisition from, and release to, the pool.
(Inherited from SharedPoolSettingsTSource.)
Public propertyRecordStatistics
Gets or sets a value indicating whether to record pool statistics.
(Inherited from SharedPoolSettingsTSource.)
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 SharedPoolSettingsTSource.)
Public propertySource
Gets or sets the game object that the pool will be used for.
(Overrides SharedPoolSettingsTSourceSource.)
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 SharedPoolSettingsTSource.)
Top
See Also