Class Registry

Central ECS registry that manages entities, components, views, and hierarchy.

Supports component pooling, cached archetype views, event hooks, and JSON serialization.

Index

Constructors

Methods

addComponent clear createEntity deserialize destroyEntity getComponent hasComponent obtain onAdded onRemoved registerComponentType removeComponent serialize setParent view

Constructors

constructor

new Registry(): Registry
Returns Registry

Methods

addComponent

addComponent<T>(
    entity: number,
    componentClass: new (...args: any[]) => T,
    component: T,
): T
Attach a component instance to an entity, triggering onAdded listeners.
Type Parameters
- T
Parameters
- entity: number
- componentClass: new (...args: any[]) => T
- component: T
Returns T
- Defined in core/ecs.ts:126

clear

clear(): void
Remove all entities, components, caches, pools, and listeners.

Returns void
- Defined in core/ecs.ts:445

createEntity

createEntity(): number
Create a new entity, reusing a recycled ID when available.

Returns number
- Defined in core/ecs.ts:64

deserialize

deserialize(json: string): void
Clear the registry and restore state from a JSON string produced by serialize().
Parameters
- json: string
Returns void
- Defined in core/ecs.ts:293

destroyEntity

destroyEntity(entity: number): void
Destroy an entity, removing all its components and hierarchy links.
Parameters
- entity: number
Returns void
- Defined in core/ecs.ts:71

getComponent

getComponent<T>(
entity: number,
componentClass: new (...args: any[]) => T,
): T | undefined
Retrieve a component from an entity, or undefined if not present.
Type Parameters
- T
Parameters
- entity: number
- componentClass: new (...args: any[]) => T
Returns T | undefined
- Defined in core/ecs.ts:152

hasComponent

hasComponent(
entity: number,
componentClass: new (...args: any[]) => any,
): boolean
Check whether an entity has a given component type.
Parameters
- entity: number
- componentClass: new (...args: any[]) => any
Returns boolean
- Defined in core/ecs.ts:161

obtain

obtain<T>(componentClass: new (...args: any[]) => T, ...args: any[]): T
Get a pooled component instance, or create a new one.

Reused instances have their init() or reset() method called with the provided args.
Type Parameters
- T
Parameters
- componentClass: new (...args: any[]) => T
- ...args: any[]
Returns T
- Defined in core/ecs.ts:422

onAdded

onAdded<T>(
componentClass: new (...args: any[]) => T,
callback: (entity: number, component: T) => void,
): () => void
Register a callback invoked whenever a component of this type is added.
Type Parameters
- T
Parameters
- componentClass: new (...args: any[]) => T
- callback: (entity: number, component: T) => void
Returns () => void
Unsubscribe function.
- Defined in core/ecs.ts:196

onRemoved

onRemoved<T>(
componentClass: new (...args: any[]) => T,
callback: (entity: number, component: T) => void,
): () => void
Register a callback invoked whenever a component of this type is removed.
Type Parameters
- T
Parameters
- componentClass: new (...args: any[]) => T
- callback: (entity: number, component: T) => void
Returns () => void
Unsubscribe function.
- Defined in core/ecs.ts:216

registerComponentType

registerComponentType(
name: string,
constructor: new (...args: any[]) => any,
): void
Register a component class for serialization under the given name.
Parameters
- name: string
- constructor: new (...args: any[]) => any
Returns void
- Defined in core/ecs.ts:258

removeComponent

removeComponent(
entity: number,
componentClass: new (...args: any[]) => any,
): void
Remove a component from an entity, triggering onRemoved listeners and pooling the instance.
Parameters
- entity: number
- componentClass: new (...args: any[]) => any
Returns void
- Defined in core/ecs.ts:167

serialize

serialize(): string
Serialize all entities and registered components to a JSON string.

Returns string
- Defined in core/ecs.ts:265

setParent

setParent(child: number, parent: number | null): void
Set or clear an entity's parent, updating Parent/Children components on both sides.
Parameters
- child: number
- parent: number | null
Returns void
- Defined in core/ecs.ts:233

view

view<T extends any[]>(
    ...componentClasses: {
        [K in string | number | symbol]: new (...args: any[]) => T[K]
    },
): number[]
Query entities matching a set of component types. Results are cached.

Accepts either component classes as rest args, or a QueryConfig with with/without arrays.
Type Parameters
- T extends any[]
Parameters
- ...componentClasses: { [K in string | number | symbol]: new (...args: any[]) => T[K] }
Returns number[]
- Defined in core/ecs.ts:354
view(config: QueryConfig): number[]
Query entities matching a set of component types. Results are cached.

Accepts either component classes as rest args, or a QueryConfig with with/without arrays.
Parameters
- config: QueryConfig
Returns number[]
- Defined in core/ecs.ts:357

Class Registry

Index

Constructors

Methods

Constructors

constructor

Returns Registry

Methods

addComponent

Type Parameters

Parameters

Returns T

clear

Returns void

createEntity

Returns number

deserialize

Parameters

Returns void

destroyEntity

Parameters

Returns void

getComponent

Type Parameters

Parameters

Returns T | undefined

hasComponent

Parameters

Returns boolean

obtain

Type Parameters

Parameters

Returns T

onAdded

Type Parameters

Parameters

Returns () => void

onRemoved

Type Parameters

Parameters

Returns () => void

registerComponentType

Parameters

Returns void

removeComponent

Parameters

Returns void

serialize

Returns string

setParent

Parameters

Returns void

view

Type Parameters

Parameters

Returns number[]

Parameters

Returns number[]

Settings

On This Page