Click or drag to resize

SharedPoolSettingsTSource Class

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

A container class for the shared settings that a GameObjectPool and a ComponentPool can have.
Inheritance Hierarchy
SystemObject
  Umbrace.Unity.PurePoolSharedPoolSettingsTSource
    Umbrace.Unity.PurePoolComponentPoolSettings
    Umbrace.Unity.PurePoolGameObjectPoolSettings

Namespace:  Umbrace.Unity.PurePool
Assembly:  Umbrace.Unity.PurePool (in Umbrace.Unity.PurePool.dll) Version: 0.0.0.0 (1.0.0.0)
Syntax
C#
[SerializableAttribute]
public abstract class SharedPoolSettings<TSource> : ISharedPoolSettings<TSource>, 
	ISharedPoolSettings

Type Parameters

TSource
The type of object being pooled.

The SharedPoolSettingsTSource type exposes the following members.

Constructors
  NameDescription
Protected methodSharedPoolSettingsTSource
Initialises a new instance of the SharedPoolSettingsTSource class, using the specified settings.
Top
Properties
  NameDescription
Public propertyDontDestroyOnLoad
Gets or sets a value indicating whether the pool should persist between scene changes.
Public propertyEnabled
Gets or sets a value indicating whether pooling is enabled.
Public propertyFrozen
Gets a value indicating whether the object has been frozen, and cannot be modified.
Public propertyInitialiseOnStart
Gets or sets a value indicating whether to initialise the pool in the MonoBehaviour Start method.
Public propertyInitialSize
Gets or sets the initial size of the pool.
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.
Public propertyLogMessages
Gets or sets the level of log messaging that the pool will output.
Public propertyMaximumSize
Gets or sets the maximum size of the pool, which is the maximum number of objects it can contain.
Public propertyNotificationMode
Gets or sets the modes in which pooled objects are notified of their acquisition from, and release to, the pool.
Public propertyRecordStatistics
Gets or sets a value indicating whether to record pool statistics.
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.
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).
Top
Methods
  NameDescription
Protected methodEnsureNotFrozen
Ensures the SharedPoolSettingsTSource has not been frozen, and throws an exception if it has.
Public methodEquals (Inherited from Object.)
Protected methodFinalize (Inherited from Object.)
Public methodFreeze
Freezes the object and prevents modifications being made to it.
Public methodGetHashCode (Inherited from Object.)
Public methodGetType (Inherited from Object.)
Protected methodMemberwiseClone (Inherited from Object.)
Public methodToString (Inherited from Object.)
Top
See Also