Class EntityFactory

Factory for creating entities from registered prefabs. Define a prefab once, spawn instances by name.

Usage:

factory.register('enemy', (scene, x, y) => {
  const e = new Entity(scene, x, y);
  e.entityType = 'enemy';
  e.addComponent('health', new Health(50));
  e.addComponent('patrol', new Patrol([...]));
  return e;
});

const enemy = factory.create('enemy', 100, 200);

Index

Constructors

constructor

Methods

acquirePooled create createMany createPool destroyPools getPool getPrefabNames has register releasePooled unregister useRegistry

Constructors

constructor

new EntityFactory(): EntityFactory
Returns EntityFactory

Methods

acquirePooled

acquirePooled(name: string, scene: Scene, x: number, y: number): Entity | null
Acquire an entity from its prefab pool (creates pool lazily if needed)
Parameters
- name: string
- scene: Scene
- x: number
- y: number
Returns Entity | null
- Defined in packages/clik-engine/src/entity/EntityFactory.ts:99

create

create(name: string, scene: Scene, x: number, y: number): Entity | null
Create an entity from a registered prefab
Parameters
- name: string
- scene: Scene
- x: number
- y: number
Returns Entity | null
- Defined in packages/clik-engine/src/entity/EntityFactory.ts:44

createMany

createMany(
    name: string,
    scene: Scene,
    positions: { x: number; y: number }[],
): Entity[]
Create multiple entities at positions
Parameters
- name: string
- scene: Scene
- positions: { x: number; y: number }[]
Returns Entity[]
- Defined in packages/clik-engine/src/entity/EntityFactory.ts:64

createPool

createPool(
    name: string,
    scene: Scene,
    config?: Partial<Omit<EntityPoolConfig, "prefabName">>,
): EntityPool
Create an entity pool for a registered prefab
Parameters
- name: string
- scene: Scene
- Optionalconfig: Partial<Omit<EntityPoolConfig, "prefabName">>
Returns EntityPool
- Defined in packages/clik-engine/src/entity/EntityFactory.ts:86

destroyPools

destroyPools(): void
Destroy all pools

Returns void
- Defined in packages/clik-engine/src/entity/EntityFactory.ts:128

getPool

getPool(name: string): EntityPool | undefined
Get a pool by prefab name
Parameters
- name: string
Returns EntityPool | undefined
- Defined in packages/clik-engine/src/entity/EntityFactory.ts:123

getPrefabNames

getPrefabNames(): string[]
Get all registered prefab names

Returns string[]
- Defined in packages/clik-engine/src/entity/EntityFactory.ts:76

has

has(name: string): boolean
Check if a prefab is registered
Parameters
- name: string
Returns boolean
- Defined in packages/clik-engine/src/entity/EntityFactory.ts:71

register

register(name: string, builder: EntityBuilder): this
Register a prefab builder
Parameters
- name: string
- builder: EntityBuilder
Returns this
- Defined in packages/clik-engine/src/entity/EntityFactory.ts:38

releasePooled

releasePooled(entity: Entity): void
Release an entity back to its pool
Parameters
- entity: Entity
Returns void
- Defined in packages/clik-engine/src/entity/EntityFactory.ts:108

unregister

unregister(name: string): void
Remove a prefab registration
Parameters
- name: string
Returns void
- Defined in packages/clik-engine/src/entity/EntityFactory.ts:81

useRegistry

useRegistry(registry: EntityRegistry): this
Optionally link to an EntityRegistry for automatic registration
Parameters
- registry: EntityRegistry
Returns this
- Defined in packages/clik-engine/src/entity/EntityFactory.ts:32

Class EntityFactory

Index

Constructors

Methods

Constructors

constructor

Returns EntityFactory

Methods

acquirePooled

Parameters

Returns Entity | null

create

Parameters

Returns Entity | null

createMany

Parameters

Returns Entity[]

createPool

Parameters

Returns EntityPool

destroyPools

Returns void

getPool

Parameters

Returns EntityPool | undefined

getPrefabNames

Returns string[]

has

Parameters

Returns boolean

register

Parameters

Returns this

releasePooled

Parameters

Returns void

unregister

Parameters

Returns void

useRegistry

Parameters

Returns this

Settings

On This Page