PoolableGameObject Class |
[This is preliminary documentation and is subject to change.]
A component that will automatically be attached to an instance of a pooled object,
to provide notifications when the object is acquired from, or released to, the pool.
Inheritance HierarchySystemObject
UnityEngineObject
UnityEngineComponent
UnityEngineBehaviour
UnityEngineMonoBehaviour
Umbrace.Unity.PurePoolPoolableObjectGameObject
Umbrace.Unity.PurePoolPoolableGameObject
UnityEngineObject
UnityEngineComponent
UnityEngineBehaviour
UnityEngineMonoBehaviour
Umbrace.Unity.PurePoolPoolableObjectGameObject
Umbrace.Unity.PurePoolPoolableGameObject
Namespace: Umbrace.Unity.PurePool
Assembly: Umbrace.Unity.PurePool (in Umbrace.Unity.PurePool.dll) Version: 0.0.0.0 (1.0.0.0)
SyntaxC#
[DisallowMultipleComponent] public class PoolableGameObject : PoolableObject<GameObject>
The PoolableGameObject type exposes the following members.
Constructors| Name | Description | |
|---|---|---|
 | PoolableGameObject | Initializes a new instance of the PoolableGameObject class |
Properties| Name | Description | |
|---|---|---|
 | CachePoolableComponents |
Gets or sets a value indicating whether to cache the components found on this GameObject that implement IPoolable.
(Inherited from PoolableObjectT.) |
| IsInPool |
Gets a value indicating whether the pooled object is currently unacquired and contained by the object pool.
(Inherited from PoolableObjectT.) |
| NotificationMode |
Gets or sets the way in which pooled objects are notified about being acquired from, and returned to, the pool.
(Inherited from PoolableObjectT.) |
| SourceObject |
Gets the source object that this pooled object is a clone of.
(Inherited from PoolableObjectT.) |
Methods| Name | Description | |
|---|---|---|
| AddToCache(Component) |
Adds a poolable component to the cache.
(Inherited from PoolableObjectT.) |
| AddToCache(IPoolable) |
Adds a poolable component to the cache.
(Inherited from PoolableObjectT.) |
| Equals | (Inherited from Object.) |
 | Finalize | (Inherited from Object.) |
| GetHashCode | (Inherited from Object.) |
| GetType | (Inherited from Object.) |
| MemberwiseClone | (Inherited from Object.) |
| OnAcquire |
Informs all poolable components that the object has been acquired from the pool.
(Inherited from PoolableObjectT.) |
| OnRelease |
Informs all poolable components that the object has been released back to the pool.
(Inherited from PoolableObjectT.) |
| RefreshCache |
Refreshes the cache of poolable components.
(Inherited from PoolableObjectT.) |
| RemoveFromCache(Component) |
Removes a poolable component from the cache.
(Inherited from PoolableObjectT.) |
| RemoveFromCache(IPoolable) |
Removes a poolable component from the cache.
(Inherited from PoolableObjectT.) |
| ToString | (Inherited from Object.) |
Events| Name | Description | |
|---|---|---|
 | Destroyed |
Occurs when the PoolableObjectT is destroyed.
(Inherited from PoolableObjectT.) |
See Also