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)
SyntaxC#
public interface ISharedPoolSettings<TSource> : ISharedPoolSettings
Type Parameters
- TSource
- The type of object being pooled.
The ISharedPoolSettingsTSource type exposes the following members.
Properties| Name | Description | |
|---|---|---|
 | DontDestroyOnLoad |
Gets or sets a value indicating whether the pool should persist between scene changes.
(Inherited from ISharedPoolSettings.) |
| Enabled |
Gets or sets a value indicating whether pooling is enabled.
(Inherited from ISharedPoolSettings.) |
| InitialiseOnStart |
Gets or sets a value indicating whether to initialise the pool in the MonoBehaviour Start method.
(Inherited from ISharedPoolSettings.) |
| InitialSize |
Gets or sets the initial size of the pool.
(Inherited from ISharedPoolSettings.) |
| 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 ISharedPoolSettings.) |
| LogMessages |
Gets or sets the level of log messaging that the pool will output.
(Inherited from ISharedPoolSettings.) |
| MaximumSize |
Gets or sets the maximum size of the pool, which is the maximum number of objects it can contain.
(Inherited from ISharedPoolSettings.) |
| NotificationMode |
Gets or sets the modes in which pooled objects are notified of their acquisition from, and release to, the pool.
(Inherited from ISharedPoolSettings.) |
| RecordStatistics |
Gets or sets a value indicating whether to record pool statistics.
(Inherited from ISharedPoolSettings.) |
| ReparentPooledObjects |
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.) |
| Source |
Gets or sets the source object that will be pooled.
|
| 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).
(Inherited from ISharedPoolSettings.) |
See Also