Class EntityPool

Object pool for entities. Reuses deactivated entities instead of creating/destroying them.

Usage:

const pool = new EntityPool(factory, scene, { prefabName: 'bullet', initialSize: 20 });
pool.useRegistry(registry);

const bullet = pool.acquire(x, y);  // get from pool or create
pool.release(bullet);                // return to pool

Index

Constructors

constructor

new EntityPool(
    factory: EntityFactory,
    scene: Scene,
    config: EntityPoolConfig,
): EntityPool
Parameters
- factory: EntityFactory
- scene: Scene
- config: EntityPoolConfig
Returns EntityPool
- Defined in packages/clik-engine/src/entity/EntityPool.ts:35

Accessors

activeCount

get activeCount(): number
Number of entities currently in use

Returns number
- Defined in packages/clik-engine/src/entity/EntityPool.ts:115

availableCount

get availableCount(): number
Number of entities available in the pool

Returns number
- Defined in packages/clik-engine/src/entity/EntityPool.ts:120

totalCount

get totalCount(): number
Total entities managed by this pool (active + available)

Returns number
- Defined in packages/clik-engine/src/entity/EntityPool.ts:125

Methods

acquire

acquire(x: number, y: number): Entity | null
Acquire an entity from the pool or create a new one
Parameters
- x: number
- y: number
Returns Entity | null
- Defined in packages/clik-engine/src/entity/EntityPool.ts:62

destroy

destroy(): void
Destroy all entities and clear the pool

Returns void
- Defined in packages/clik-engine/src/entity/EntityPool.ts:130

prewarm

prewarm(count: number): void
Pre-create entities to avoid allocation during gameplay
Parameters
- count: number
Returns void
- Defined in packages/clik-engine/src/entity/EntityPool.ts:49

release

release(entity: Entity): void
Return an entity to the pool for reuse
Parameters
- entity: Entity
Returns void
- Defined in packages/clik-engine/src/entity/EntityPool.ts:95

releaseAll

releaseAll(): void
Release all active entities back to the pool

Returns void
- Defined in packages/clik-engine/src/entity/EntityPool.ts:108

useRegistry

useRegistry(registry: EntityRegistry): this
Link to an EntityRegistry — acquired entities auto-register, released entities auto-unregister
Parameters
- registry: EntityRegistry
Returns this
- Defined in packages/clik-engine/src/entity/EntityPool.ts:43

Class EntityPool

Index

Constructors

Accessors

Methods

Constructors

constructor

Parameters

Returns EntityPool

Accessors

activeCount

Returns number

availableCount

Returns number

totalCount

Returns number

Methods

acquire

Parameters

Returns Entity | null

destroy

Returns void

prewarm

Parameters

Returns void

release

Parameters

Returns void

releaseAll

Returns void

useRegistry

Parameters

Returns this

Settings

On This Page