Class Registry

The central object of the ECS system.

Hierarchy

Registry

Index

Constructors

constructor

Properties

Methods

Constructors

constructor

new Registry(): Registry

- Defined in ecs.ts:17
Returns Registry

Properties

Private cCounter

cCounter: number

components

components: Map<symbol, { defVal: object; map: Map<symbol, object>; name: string }>

Private eCounter

eCounter: number

entities

entities: Map<symbol, { compList: symbol[] }>

Private selectedEntity

selectedEntity: symbol

Methods

addComponent

addComponent(comp: string | symbol): Registry
addComponent(comp: string | symbol, values: any): Registry

- Defined in ecs.ts:59
Add a component to the selected entity.

Parameters
- comp: string | symbol
Returns Registry
- Defined in ecs.ts:60
Parameters
- comp: string | symbol
- values: any
Returns Registry

componentByName

componentByName(name: string): symbol

- Defined in ecs.ts:148
Return a component from its name.

Parameters
- name: string
Returns symbol

entity

entity(): Registry
entity(name: any): Registry

- Defined in ecs.ts:26
Create and select an entity.

Returns Registry
- Defined in ecs.ts:27
Parameters
- name: any
Returns Registry

entityByName

entityByName(ent: string): symbol

- Defined in ecs.ts:52
Return an entity from its name.

Parameters
- ent: string
Returns symbol

entityData

entityData(): any
entityData(ent: symbol): any

- Defined in ecs.ts:114
Return all data of a given entity

Returns any
- Defined in ecs.ts:115
Parameters
- ent: symbol
Returns any

makeComponent

makeComponent(name: string): symbol
makeComponent(name: string, defVal: object): symbol

- Defined in ecs.ts:137
Create a new component.

Parameters
- name: string
Returns symbol
- Defined in ecs.ts:138
Parameters
- name: string
- defVal: object
Returns symbol

queryAll

queryAll(callback: ((...compVals: any[]) => void), ...comps: symbol[]): Registry

- Defined in ecs.ts:85
Map callback to all entities that have every components in comps. When callback is called, the corresponding entity is selected.

Parameters
- callback: ((...compVals: any[]) => void)
  - - (...compVals: any[]): void
    - Parameters
      - Rest ...compVals: any[]
      Returns void
- Rest ...comps: symbol[]
Returns Registry

Generated using TypeDoc