Class Ecs<M>

Type parameters

M

Hierarchy

Ecs

Constructors

constructor

Properties

Methods

Constructors

constructor

new Ecs(componentManagers: ComponentManagerMap<M>, poolOptions?: Partial<EntityPoolOptions>): Ecs

- Defined in ecs/src/classes/Ecs.ts:12
Glues an EntityPool with ComponentManagers.

Parameters
- componentManagers: ComponentManagerMap<M>
  
  The Map of componentManagers to use.
- Default value poolOptions: Partial<EntityPoolOptions> = {}
  
  Options for the entityPool.
Returns Ecs

Properties

componentManagers

componentManagers: ComponentManagerMap<M>

The Map of componentManagers to use.

pool

pool: EntityPool

Entity pool used to generate entities.

Methods

createEntity

createEntity(components?: Partial<ExtractComponentMap<M>>): number

- Defined in ecs/src/classes/Ecs.ts:33
Generates an entity id, registers the passed components.

Parameters
- Default value components: Partial<ExtractComponentMap<M>> = {}
  
  The components the entity should have.
Returns number

The entity id.

deleteEntity

deleteEntity(id: number): void

- Defined in ecs/src/classes/Ecs.ts:51
Deletes and entity by id.

Parameters
- id: number
  
  The id of the enity to delete.
Returns void

getComponentsByEntityId

getComponentsByEntityId<L>(id: number, components: L): object

- Defined in ecs/src/classes/Ecs.ts:90
Gets a few components for a given id.

Type parameters
- L: ReadonlyArray<keyof M>
Parameters
- id: number
  
  The id of the entity to get components from.
- components: L
  
  List with what components to get.
Returns object

getEntityById

getEntityById<L>(id: number): L

- Defined in ecs/src/classes/Ecs.ts:67
Gets all components of the entity with the given id.

Note: If you only want to get a few of the components, use the getComponentsByEntityId method instead.

Type parameters
- L: Partial<ExtractComponentMap<M>>
Parameters
- id: number
  
  The id of the entity.
Returns L

Generated using TypeDoc