PoolManagerBaseTManagerSettings, TPool, TPoolSettings, TSource, TInstance Class

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

An abstract class that provides shared functionality to manage a collection of PoolBaseTSource, TInstance, TSettings components, simplifying access to the pools and allowing for automatic pool creation.

Inheritance Hierarchy

SystemObject
  UnityEngineObject
    UnityEngineComponent
      UnityEngineBehaviour
        UnityEngineMonoBehaviour
          Umbrace.Unity.PurePoolPoolManagerBaseTManagerSettings, TPool, TPoolSettings, TSource, TInstance
            Umbrace.Unity.PurePoolComponentPoolManager
            Umbrace.Unity.PurePoolGameObjectPoolManager

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

Syntax

Copy

public abstract class PoolManagerBase<TManagerSettings, TPool, TPoolSettings, TSource, TInstance> : MonoBehaviour, 
	ISerializationCallbackReceiver
where TManagerSettings : PoolManagerSettings<TPoolSettings, TSource>
where TPool : PoolBase<TSource, TInstance, TPoolSettings>
where TPoolSettings : new(), SharedPoolSettings<TSource>

Type Parameters

TManagerSettings: The type of the manager's settings.
TPool: The type of the pools maintained by the manager.
TPoolSettings: The type of the settings used by the pools.
TSource: The type used to identify the desired source when acquiring an instance.
TInstance: The type of the instances returned from the pools.

The PoolManagerBaseTManagerSettings, TPool, TPoolSettings, TSource, TInstance type exposes the following members.

Constructors

	Name	Description
	PoolManagerBaseTManagerSettings, TPool, TPoolSettings, TSource, TInstance	Initializes a new instance of the PoolManagerBaseTManagerSettings, TPool, TPoolSettings, TSource, TInstance class

Top

Properties

	Name	Description
	AcquireMode	Gets or sets the way in which to handle attempts to acquire an object, for which no pool exists.
	AttachDescendentPools	Gets or sets value indicating whether to attach all descendent pools to the manager on startup.
	DefaultPoolSettings	Gets the settings that are used when a new pool is created.
	DontDestroyOnLoad	Gets or sets a value indicating whether the pool manager (and the pools beneath it) will remain in the scene when a new scene is loaded.
	Enabled	Gets or sets a value indicating whether pooling is enabled.
	ObjectPools	When overridden in a derived class, gets the internal object pool dictionary, mapping from the source object to its pool.
	PoolCount	Gets the number of pools attached to the manager.
	Pools	Gets the collection of pools attached to the manager.

Top

Methods

	Name	Description
	Acquire	Acquires an instance of source from an attached pool.
	AttachPool	Attaches the specified pool to the manager, allowing the manager to acquire and release instances from it.
	Awake
	CanAcquire	Determines whether an instance of sourceObject can be acquired from its pool.
	CreatePool(TPoolSettings)	Creates a new pool using the specified settings, and attaches it to the manager. The pool is created on a child object of the manager's game object.
	CreatePool(TPoolSettings, GameObject, Boolean, String)	Creates a new pool using the specified settings, and attaches it to the manager.
	DestroyPool	Destroys the specified pool that's attached to the manager.
	DetachPool	Detaches the specified pool from the manager, without destroying it.
	Equals	(Inherited from Object.)
	Finalize	(Inherited from Object.)
	FindChildPools	Finds all pools that are parented to the manager's game object.
	GetHashCode	(Inherited from Object.)
	GetPool	Gets the pool that handles instances of the specified source object. The manager must contain a matching pool to use this method.
	GetPooledCount	Gets the number of instances of the specified object contained in the pool.
	GetSourceName	When implemented in a derived class, gets the name of the specified source.
	GetType	(Inherited from Object.)
	HasPool	Determines whether the manager has a pool that handles instances of the specified source object.
	InternalAcquire	When implemented in a derived class, attempts to acquire an instance of a source according to AcquireMode.
	IsAttached	Determines whether the specified pool is attached to the manager.
	IsPoolEmpty	Determines whether the pool is empty for instances of the specified object.
	MemberwiseClone	(Inherited from Object.)
	OnPoolAttached	Raises the PoolAttached event.
	OnPoolCreated	Raises the PoolCreated event.
	OnPoolDestroyed	Raises the PoolDestroyed event.
	OnPoolDetached	Raises the PoolDetached event.
	Release	Releases an instance that was previously acquired from an attached pool.
	ReleaseInternal	When overridden in a derived class, releases an instance that was previously acquired from an attached pool.
	ToString	(Inherited from Object.)
	TryAcquire	Acquires an instance of sourceObject from an attached pool.
	TryGetPool	Gets the pool that handles instances of the specified source object.

Top

Events

	Name	Description
	PoolAttached	Occurs when a GameObjectPool is attached to the manager.
	PoolCreated	Occurs when a GameObjectPool is created by the manager.
	PoolDestroyed	Occurs when a GameObjectPool is destroyed by the manager.
	PoolDetached	Occurs when a GameObjectPool is detached from the manager.

Top

Reference

Umbrace.Unity.PurePool Namespace

PoolManagerBaseAddLanguageSpecificTextSet("LSTAF7287DD_0?cs=&lt;|vb=(Of |cpp=&lt;|fs=&lt;'|nu=(");TManagerSettings, TPool, TPoolSettings, TSource, TInstanceAddLanguageSpecificTextSet("LSTAF7287DD_1?cs=&gt;|vb=)|cpp=&gt;|fs=&gt;|nu=)"); Class

Type Parameters

Reference

PoolManagerBaseTManagerSettings, TPool, TPoolSettings, TSource, TInstance Class