GameObjectPoolSettings Class

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

A container class for the settings that a GameObjectPool can have.

Inheritance Hierarchy

SystemObject
Umbrace.Unity.PurePoolSharedPoolSettingsGameObject
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

Copy

[SerializableAttribute]
public class GameObjectPoolSettings : SharedPoolSettings<GameObject>, 
	IGameObjectPoolSettings, ISharedPoolSettings<GameObject>, ISharedPoolSettings

The GameObjectPoolSettings type exposes the following members.

Constructors

	Name	Description
	GameObjectPoolSettings	Initialises a new instance of the GameObjectPoolSettings class.
	GameObjectPoolSettings(GameObjectPoolSettings)	Initialises a new instance of the GameObjectPoolSettings class, using the specified settings.

Top

Properties

	Name	Description
	DefaultSettings	Gets the default settings.
	DontDestroyOnLoad	Gets or sets a value indicating whether the pool should persist between scene changes. (Inherited from SharedPoolSettingsTSource.)
	Enabled	Gets or sets a value indicating whether pooling is enabled. (Inherited from SharedPoolSettingsTSource.)
	Frozen	Gets a value indicating whether the object has been frozen, and cannot be modified. (Inherited from SharedPoolSettingsTSource.)
	InitialiseOnStart	Gets or sets a value indicating whether to initialise the pool in the MonoBehaviour Start method. (Inherited from SharedPoolSettingsTSource.)
	InitialSize	Gets or sets the initial size of the pool. (Inherited from SharedPoolSettingsTSource.)
	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 SharedPoolSettingsTSource.)
	LogMessages	Gets or sets the level of log messaging that the pool will output. (Inherited from SharedPoolSettingsTSource.)
	MaximumSize	Gets or sets the maximum size of the pool, which is the maximum number of objects it can contain. (Inherited from SharedPoolSettingsTSource.)
	NotificationMode	Gets or sets the modes in which pooled objects are notified of their acquisition from, and release to, the pool. (Inherited from SharedPoolSettingsTSource.)
	RecordStatistics	Gets or sets a value indicating whether to record pool statistics. (Inherited from SharedPoolSettingsTSource.)
	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 SharedPoolSettingsTSource.)
	Source	Gets or sets the game object that the pool will be used for. (Overrides SharedPoolSettingsTSourceSource.)
	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 SharedPoolSettingsTSource.)

Top

Methods

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

Top

Reference

Umbrace.Unity.PurePool Namespace