Click or drag to resize

ISharedPoolSettingsTSource Interface

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

An interface that defines the shared settings that can be changed on a GameObject pool and a Component pool.

Namespace:  Umbrace.Unity.PurePool
Assembly:  Umbrace.Unity.PurePool (in Umbrace.Unity.PurePool.dll) Version: 0.0.0.0 (1.0.0.0)
Syntax
C#
public interface ISharedPoolSettings<TSource> : ISharedPoolSettings

Type Parameters

TSource
The type of object being pooled.

The ISharedPoolSettingsTSource type exposes the following members.

Properties
  NameDescription
Public propertyDontDestroyOnLoad
Gets or sets a value indicating whether the pool should persist between scene changes.
(Inherited from ISharedPoolSettings.)
Public propertyEnabled
Gets or sets a value indicating whether pooling is enabled.
(Inherited from ISharedPoolSettings.)
Public propertyInitialiseOnStart
Gets or sets a value indicating whether to initialise the pool in the MonoBehaviour Start method.
(Inherited from ISharedPoolSettings.)
Public propertyInitialSize
Gets or sets the initial size of the pool.
(Inherited from ISharedPoolSettings.)
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 ISharedPoolSettings.)
Public propertyLogMessages
Gets or sets the level of log messaging that the pool will output.
(Inherited from ISharedPoolSettings.)
Public propertyMaximumSize
Gets or sets the maximum size of the pool, which is the maximum number of objects it can contain.
(Inherited from ISharedPoolSettings.)
Public propertyNotificationMode
Gets or sets the modes in which pooled objects are notified of their acquisition from, and release to, the pool.
(Inherited from ISharedPoolSettings.)
Public propertyRecordStatistics
Gets or sets a value indicating whether to record pool statistics.
(Inherited from ISharedPoolSettings.)
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 ISharedPoolSettings.)
Public propertySource
Gets or sets the source object that will be pooled.
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 ISharedPoolSettings.)
Top
See Also