PoolableObjectT 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.PurePoolPoolableObjectT
Umbrace.Unity.PurePoolPoolableComponent
Umbrace.Unity.PurePoolPoolableGameObject
UnityEngineObject
UnityEngineComponent
UnityEngineBehaviour
UnityEngineMonoBehaviour
Umbrace.Unity.PurePoolPoolableObjectT
Umbrace.Unity.PurePoolPoolableComponent
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#
public abstract class PoolableObject<T> : MonoBehaviour, ISerializationCallbackReceiver
Type Parameters
- T
- The type of object being pooled.
The PoolableObjectT type exposes the following members.
Constructors| Name | Description | |
|---|---|---|
 | PoolableObjectT | Initializes a new instance of the PoolableObjectT class |
Properties| Name | Description | |
|---|---|---|
 | CachePoolableComponents |
Gets or sets a value indicating whether to cache the components found on this GameObject that implement IPoolable.
|
| IsInPool |
Gets a value indicating whether the pooled object is currently unacquired and contained by the object pool.
|
| NotificationMode |
Gets or sets the way in which pooled objects are notified about being acquired from, and returned to, the pool.
|
| SourceObject |
Gets the source object that this pooled object is a clone of.
|
Methods| Name | Description | |
|---|---|---|
 | AddToCache(Component) |
Adds a poolable component to the cache.
|
| AddToCache(IPoolable) |
Adds a poolable component to the cache.
|
| 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.
|
| OnRelease |
Informs all poolable components that the object has been released back to the pool.
|
| RefreshCache |
Refreshes the cache of poolable components.
|
| RemoveFromCache(Component) |
Removes a poolable component from the cache.
|
| RemoveFromCache(IPoolable) |
Removes a poolable component from the cache.
|
| ToString | (Inherited from Object.) |
Events
See Also