Class InstancePool<T>

Bounded generic Roblox Instance pool.

Type Parameters

T extends Instance

Index

Constructors

Methods

acquire destroy release releaseAll statistics

Constructors

constructor

new InstancePool<T extends Instance>(
capacity: number,
policy: InstancePoolPolicy<T>,
): InstancePool<T>
Type Parameters
- T extends Instance
Parameters
- capacity: number
- policy: InstancePoolPolicy<T>
Returns InstancePool<T>
- Defined in roblox/pool.ts:26

Methods

acquire

acquire(): T | undefined
Acquires a reset Instance or allocates within capacity.

Returns T | undefined
- Defined in roblox/pool.ts:34

destroy

destroy(): void
Permanently destroys all used and available Instances.

Returns void
- Defined in roblox/pool.ts:77

release

release(instance: T): boolean
Resets and releases an in-use Instance.
Parameters
- instance: T
Returns boolean
- Defined in roblox/pool.ts:49

releaseAll

releaseAll(): void
Releases every currently in-use Instance.

Returns void
- Defined in roblox/pool.ts:59

statistics

statistics(): InstancePoolStatistics
Returns allocation, usage, availability, and exhaustion counters.

Returns InstancePoolStatistics
- Defined in roblox/pool.ts:67