ObjectPool

Inherits: Class

Methods

Acquire

function ObjectPool:Acquire()
  -> <T>, boolean

Acquires an object from the pool, creating one if necessary.

Returns:

Name	Type	Description
``	<T>
isNew	boolean

EnumerateActive

function ObjectPool:EnumerateActive()
  -> fun():T

Returns an iterator over all currently active objects in the pool.

Returns:

Type	Description
fun():T

EnumerateInactive

function ObjectPool:EnumerateInactive()
  -> fun():T

Returns an iterator over all currently inactive objects in the pool.

Returns:

Type	Description
fun():T

Get

function ObjectPool:Get()
  -> <T>

Either returns a recycled instance of the object or creates a new one as applicable.

Returns:

Type	Description
<T>

GetNumActive

function ObjectPool:GetNumActive()
  -> number

Returns the number of currently active objects in the pool.

Returns:

Type	Description
number

Recycle

function ObjectPool:Recycle(obj)

Recycles an instance of the object back into the pool.

Parameters:

Name	Type	Description
obj	T	The object to recycle

Release

function ObjectPool:Release(obj)

Releases the given object back into the pool.

Parameters:

Name	Type	Description
obj	T

ReleaseAll

function ObjectPool:ReleaseAll()

Releases all active objects back into the pool.

_GetDebugInfo

function ObjectPool:_GetDebugInfo()

__init

function ObjectPool:__init(createFunc, extraStackOffset)

Parameters:

Name	Type	Description
createFunc	``
extraStackOffset	``

Functions

EnableLeakDebug

function ObjectPool.EnableLeakDebug()

Enables leak debugging.

GetDebugInfo

function ObjectPool.GetDebugInfo()
  -> table<string, ObjectPoolDebugInfo>

Gets debug information which represents the current state of all the created object pools

Returns:

Type	Description
table<string, ObjectPoolDebugInfo>

New

function ObjectPool.New(name, createFunc, extraStackOffset)
  -> ObjectPool

Create a new object pool.

Parameters:

Name	Type	Description
name	string	The name of the object pool for debug purposes
createFunc	fun(): T | T	The function which is called to create a new object, or a Class
extraStackOffset	number	The extra stack offset for tracking where objects are being used from or nil to disable stack info

Returns:

Type	Description
ObjectPool