Askowl.Pool Class Reference

MonoBehaviour to provide pooling functionality for child GameObjects. To be eligible they must be created with Acquire and disabled but not destroyed. More...

Inheritance diagram for Askowl.Pool:

Classes
class	PoolQueue
	Each GameObject enabled for pooling resides in a PoolQueue. More...

Static Public Member Functions
static T	Acquire< T > (string name, Vector3 position=default, Quaternion rotation=default, Transform parent=default, bool enable=true, bool poolOnDisable=true)
	Use Pool.Acquire<T>() to get a reference to a cloned gameObject instead of Instantiate<T>(). All parameters bar name are optional. More...
static GameObject	Acquire (string name, Vector3 position=default, Quaternion rotation=default, Transform parent=null, bool enable=true, bool poolOnDisable=true)
	Use Pool.Acquire() to get a reference to a cloned gameObject instead of Instantiate(). All parameters bar name are optional. More...
static void	Return (GameObject clone)
	Give an object created by Acquire in any pool, return it to the pool for reuse. Only needed if poolOnDisable is false More...
static PoolQueue	PoolFor (string name, Pool pool=null)
	Retrieve a reference to the pooling queue for the GameObject named More...

Detailed Description

MonoBehaviour to provide pooling functionality for child GameObjects. To be eligible they must be created with Acquire and disabled but not destroyed.

Definition at line 8 of file Pool.cs.

Member Function Documentation

Acquire()

static GameObject Askowl.Pool.Acquire ( string  name, Vector3  position = default, Quaternion  rotation = default, Transform  parent = null, bool  enable = true, bool  poolOnDisable = true  )

static

Use Pool.Acquire() to get a reference to a cloned gameObject instead of Instantiate(). All parameters bar name are optional.

Definition at line 58 of file Pool.cs.

Acquire< T >()

static T Askowl.Pool.Acquire< T > ( string  name, Vector3  position = default, Quaternion  rotation = default, Transform  parent = default, bool  enable = true, bool  poolOnDisable = true  )

static

Use Pool.Acquire<T>() to get a reference to a cloned gameObject instead of Instantiate<T>(). All parameters bar name are optional.

Type Constraints

T

:

Component

Definition at line 50 of file Pool.cs.

PoolFor()

static PoolQueue Askowl.Pool.PoolFor ( string  name, Pool  pool = null  )

static

Retrieve a reference to the pooling queue for the GameObject named

Definition at line 116 of file Pool.cs.

Return()

static void Askowl.Pool.Return ( GameObject  clone )

static

Give an object created by Acquire in any pool, return it to the pool for reuse. Only needed if poolOnDisable is false

Definition at line 87 of file Pool.cs.

---

The documentation for this class was generated from the following file:

• Pool.cs