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

Namespace: Umbrace.Unity.PurePool
Assembly: Umbrace.Unity.PurePool (in Umbrace.Unity.PurePool.dll) Version: 0.0.0.0 (1.0.0.0)

Syntax

[SerializableAttribute]
public abstract class SharedPoolSettings<TSource> : ISharedPoolSettings<TSource>, 
	ISharedPoolSettings

The SharedPoolSettingsTSource type exposes the following members.

Constructors

	Name	Description
	SharedPoolSettingsTSource	Initialises a new instance of the SharedPoolSettingsTSource class, using the specified settings.

Properties

	Name	Description
	DontDestroyOnLoad	Gets or sets a value indicating whether the pool should persist between scene changes.
	Enabled	Gets or sets a value indicating whether pooling is enabled.
	Frozen	Gets a value indicating whether the object has been frozen, and cannot be modified.
	InitialiseOnStart	Gets or sets a value indicating whether to initialise the pool in the MonoBehaviour Start method.
	InitialSize	Gets or sets the initial size of the pool.
	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.
	LogMessages	Gets or sets the level of log messaging that the pool will output.
	MaximumSize	Gets or sets the maximum size of the pool, which is the maximum number of objects it can contain.
	NotificationMode	Gets or sets the modes in which pooled objects are notified of their acquisition from, and release to, the pool.
	RecordStatistics	Gets or sets a value indicating whether to record pool statistics.
	ReparentPooledObjects	Gets or sets a value indicating whether to re-parent the pooled objects to the pool's transform, after the objects are released.
	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).

Methods

	Name	Description
	EnsureNotFrozen	Ensures the SharedPoolSettingsTSource has not been frozen, and throws an exception if it has.
	Equals	(Inherited from Object.)
	Finalize	(Inherited from Object.)
	Freeze	Freezes the object and prevents modifications being made to it.
	GetHashCode	(Inherited from Object.)
	GetType	(Inherited from Object.)
	MemberwiseClone	(Inherited from Object.)
	ToString	(Inherited from Object.)

SharedPoolSettingsAddLanguageSpecificTextSet("LSTF8F36AEB_0?cs=&lt;|vb=(Of |cpp=&lt;|fs=&lt;'|nu=(");TSourceAddLanguageSpecificTextSet("LSTF8F36AEB_1?cs=&gt;|vb=)|cpp=&gt;|fs=&gt;|nu=)"); Class