PoolableObject Class

Add this component to your prefab to make it poolable.

Inheritance Hierarchy

SystemObject
  Object
    Component
      Behaviour
        MonoBehaviour
          (Default Namespace)PoolableObject

Namespace: (Default Namespace)
Assembly: AudioToolkit (in AudioToolkit.dll) Version: 8.2.0.0 (8.2.0.0)

Syntax

public class PoolableObject : MonoBehaviour

The PoolableObject type exposes the following members.

Constructors

	Name	Description
	PoolableObject	Initializes a new instance of the PoolableObject class

Methods

	Name	Description
	DeactivateAllPoolableObjectsOfMyKind	Moves all poolable objects of this kind (instantiated from the same prefab as this instance) back to the pool.
	GetAllPoolableObjectsOfMyKind	Retrieves an array of all poolable objects of this kind (instantiated from the same prefab as this instance).
	GetSerialNumber	Gets the object's pool serial number. Each object has a unique serial number. Can be useful for debugging purposes.
	GetUsageCount	Gets the usage counter which gets increased each time an object is re-used from the pool.
	IsDeactivated	Checks if the object is deactivated and in the pool.

Fields

	Name	Description
	doNotDestroyOnLoad	If enabled the object will not get destroyed if a new scene is loaded
	maxPoolSize	The maximum number of instances of this prefab to get stored in the pool.
	preloadCount	This number of instances will be preloaded to the pool if Preload(GameObject) is called.
	sendAwakeStartOnDestroyMessage	If enabled Awake(), Start(), and OnDestroy() messages are sent to the poolable object if the object is set active respectively inactive whenever Destroy(GameObject) or Instantiate(GameObject) is called. This way it is simulated that the object really gets instantiated respectively destroyed.
	sendPoolableActivateDeactivateMessages	If enabled a OnPoolableObjectActivated and OnPoolableObjectDeactivated message is sent to the poolable instance if the object is activated respectively deactivated by the ObjectPoolController

Remarks

See ObjectPoolController for an explanation how to set up a prefab for pooling. The following messages are sent to a poolable object:

Awake and OnDestroy whenever a poolable object is activated or deactivated from the pool. This way the same behaviour is simulated as if the object was instantiated respectively destroyed. These messages are only sent when sendAwakeStartOnDestroyMessage is enabled.
OnPoolableInstanceAwake and OnPoolableInstanceDestroy when the object was actually instantiated respectively destroyed. Because of current Unity limitations OnPoolableInstanceDestroy does not work on Flash!
OnPoolableObjectActivated and OnPoolableObjectDeactivated whenever a poolable object is activated or deactivated from the pool. These messages are only sent when sendPoolableActivateDeactivateMessages is enabled.