Class EntityComponentSystem

The Entity Component System class.

Hierarchy

EntityComponentSystem

Constructors

constructor

new EntityComponentSystem(): EntityComponentSystem
Returns EntityComponentSystem
- Defined in index.ts:43

Properties

components

components: Component[]

All registered components

Default Value

[]

entities

entities: Entity[]

All registered entities

Default Value

[]

processors

processors: Processor[]

All registered processors

Default Value

[]

Methods

addComponent

addComponent(component): void
Adds a component to the system.
Parameters
- component: Component
  
  component object
Returns void
Void if successful
- Defined in index.ts:376

addComponentToEntity

addComponentToEntity(entity, component): void
Adds a component to an entity.
Parameters
- entity: Entity
  
  entity object
- component: string
  
  Name of component
Returns void
Void if operation is successful or throws an error.
- Defined in index.ts:332

addEntity

addEntity(entity): void
Adds a entity to the system.
Parameters
- entity: Entity
  
  entity object
Returns void
Void if successful
- Defined in index.ts:367

addProcessor

addProcessor(processor): void
Adds a processor to the system.
Parameters
- processor: Processor
  
  processor object
Returns void
Void if successful
- Defined in index.ts:391

addProcessorToEntity

addProcessorToEntity(entity, processor): void
Adds a processor to an entity.
Parameters
- entity: Entity
  
  entity object
- processor: string
  
  Name of processor
Returns void
Void if operation is successful or throws an error.
- Defined in index.ts:350

createEntity

createEntity(name, components, processors): Entity
Composes a entity with given components.
Parameters
- name: string
  
  Name of the entity
- components: string[]
  
  An array of component names
- processors: string[]
  
  An array of processor names
Returns Entity
The composed entity or throws an error.
- Defined in index.ts:213

entityHasComponent

entityHasComponent(entity, component): boolean
Checks if an entity has target component.
Parameters
- entity: Entity
  
  entity object
- component: string
  
  Name of component
Returns boolean
true if entity has the component or false if not
- Defined in index.ts:248

entityHasProcessor

entityHasProcessor(entity, processor): boolean
Checks if an entity has target processor.
Parameters
- entity: Entity
  
  entity object
- processor: string
  
  Name of processor
Returns boolean
true if entity has the processor or false if not
- Defined in index.ts:266

getComponent

getComponent(name): Component
Gets a registered component by name.
Parameters
- name: string
  
  Name of the component
Returns Component
A component or throws an error.
- Defined in index.ts:93

getComponents

getComponents(): Component[]
Gets all components processors.

Returns Component[]
All registered components in an array.
- Defined in index.ts:61

getEntities

getEntities(): Entity[]
Gets all registered entities.

Returns Entity[]
All registered entities in an array.
- Defined in index.ts:69

getEntitiesByName

getEntitiesByName(name): Entity[]
Gets all registered entities that match the given name.
Parameters
- name: string
  
  Name of the entity
Returns Entity[]
An array of entities or an empty array.
- Defined in index.ts:123

`Private` getEntitiesFromRequiredComponents

getEntitiesFromRequiredComponents(components): Entity[]
Gets all entities that have the target component registered.
Parameters
- components: string[]
Returns Entity[]
All entities in an array.
- Defined in index.ts:427

getEntity

getEntity(name): Entity
Gets a registered entity by name.
Parameters
- name: string
  
  Name of the entity
Returns Entity
A entity or throws an error.
- Defined in index.ts:108

getEntityComponents

getEntityComponents(entity, components): Component[]
Parameters
- entity: Entity
- components: string[]
Returns Component[]
- Defined in index.ts:138

getProcessor

getProcessor(name): Processor
Gets a registered processor by name.
Parameters
- name: string
  
  Name of the processor
Returns Processor
A processor or throws an error.
- Defined in index.ts:78

getProcessors

getProcessors(): Processor[]
Gets all registered processors.

Returns Processor[]
All registered processors in an array.
- Defined in index.ts:53

hasComponent

hasComponent(name): boolean
Checks if component is registered.
Parameters
- name: string
  
  Name of the component
Returns boolean
true if found or false if not.
- Defined in index.ts:177

hasEntity

hasEntity(name): boolean
Checks if entity is registered.
Parameters
- name: string
  
  Name of the entity
Returns boolean
true if found or false if not.
- Defined in index.ts:194

hasProcessor

hasProcessor(name): boolean
Checks if processor is registered by name.
Parameters
- name: string
  
  Name of the processor
Returns boolean
true if found or false if not.
- Defined in index.ts:160

removeAllEntities

removeAllEntities(): void
Removes all entities from the system.

Returns void
void
- Defined in index.ts:418

removeComponentFromEntity

removeComponentFromEntity(entity, component): void
Removes a component from an entity.
Parameters
- entity: Entity
  
  entity object
- component: string
  
  Name of component
Returns void
Void if operation successful or throw an error.
- Defined in index.ts:284

removeEntity

removeEntity(entity): void
Removes an entity from the system.
Parameters
- entity: Entity
  
  entity object
Returns void
Void if successful or throws an error.
- Defined in index.ts:400

removeProcessorFromEntity

removeProcessorFromEntity(entity, processor): void
Removes processor from an entity.
Parameters
- entity: Entity
  
  entity object
- processor: string
  
  Name of processor
Returns void
Void if operation successful or throws an error.
- Defined in index.ts:308

`Private` runProcessors

runProcessors(): void
Runs all processors for it's corresponding components e.g. run the prcoessors update function.

Returns void
Void if successful
- Defined in index.ts:457

update

update(): void
Runs all processors. This should be done per frame e.g. inside your gameloop.

Returns void
Void if successful
- Defined in index.ts:478

Generated using TypeDoc