 | GameObjectPoolT Class |
An object pool that can recycle prefab instances.
Inheritance HierarchyNamespace: Archon.SwissArmyLib.Pooling
Assembly: Archon.SwissArmyLib (in Archon.SwissArmyLib.dll) Version: 1.0.0.0 (1.0.0.0)
SyntaxC#
public class GameObjectPool<T> : Pool<T>, IDisposable where T : Object
Type Parameters
- T
- The type of the component on the prefab.
The GameObjectPoolT type exposes the following members.
Constructors| Name | Description | |
|---|---|---|
 | GameObjectPoolT(T, Boolean) |
Creates a new GameObject pool for the specified prefab.
|
| GameObjectPoolT(String, FuncT, Boolean) |
Creates a new GameObject pool with a custom name and a factory method used for instantiating instances.
|
Properties| Name | Description | |
|---|---|---|
 | FreeCount |
Gets the current amount of free instances in the pool.
(Inherited from PoolT.) |
| Prefab |
Gets the prefab used to instantiate GameObjects.
|
Methods| Name | Description | |
|---|---|---|
| CancelDespawn |
Cancels a pending timed despawn.
(Inherited from PoolT.) |
| Despawn(T) |
Despawns an object, adding it back to the pool.
(Overrides PoolTDespawn(T).) |
| Despawn(T, Single, Boolean) |
Despawns an object after a delay.
(Inherited from PoolT.) |
| Dispose |
Destroys the pool and any despawned objects in it.
|
| Equals | Determines whether the specified Object is equal to the current Object. (Inherited from Object.) |
 | Finalize |
Destructor.
(Overrides ObjectFinalize.) |
| GetHashCode | Serves as a hash function for a particular type. (Inherited from Object.) |
| GetType | Gets the type of the current instance. (Inherited from Object.) |
| MemberwiseClone | Creates a shallow copy of the current Object. (Inherited from Object.) |
| OnDespawned |
Called when an object has been despawned and placed back in the pool.
(Inherited from PoolT.) |
| OnSpawned |
Called when an object has been spawned and removed from the pool.
(Overrides PoolTOnSpawned(T).) |
| Prewarm |
Fills the pool with objects so that it contains the specified amount of objects.
If it already contains the specified amount or more, nothing will be done.
(Inherited from PoolT.) |
| Spawn |
Spawns a recycled object if there's one available, otherwise creates a new instance.
(Inherited from PoolT.) |
| Spawn(Transform) |
Spawns a recycled object if there's one available, otherwise creates a new instance.
|
| Spawn(Vector3) |
Spawns a recycled object if there's one available, otherwise creates a new instance.
|
| Spawn(Vector3, Quaternion) |
Spawns a recycled object if there's one available, otherwise creates a new instance.
|
| Spawn(Vector3, Quaternion, Transform) |
Spawns a recycled object if there's one available, otherwise creates a new instance.
|
| SpawnInternal |
Recycles or creates a object if there's one available without calling OnSpawned(T).
(Overrides PoolTSpawnInternal.) |
| ToString | Returns a string that represents the current object. (Inherited from Object.) |
Fields
See Also