Class IndexedComponentManager<T>

Type parameters

T

Hierarchy

IndexedComponentManager

Implements

ComponentManager<T>

Properties

Methods

Properties

components

components: T[] = new Array<T>()

Array with all components.

emitter

emitter: BitFieldEmitter<number> = new BitFieldEmitter<number>(3)

Standard component manager emitter.

idToIndex

idToIndex: Map<number, number> = new Map<number, number>()

MAp for getting the index of an entity from it's id

indexToId

indexToId: Map<number, number> = new Map<number, number>()

Map for getting the id of an entity from it's index.

Methods

clear

clear(): this

- Defined in ecs/src/classes/IndexedComponentManager.ts:97
Do cleanup.

Returns this

deleteEntity

deleteEntity(id: number): this

Implementation of ComponentManager.deleteEntity
- Defined in ecs/src/classes/IndexedComponentManager.ts:51
Delete an entity.

Parameters
- id: number
  
  The if of the entity to remove.
Returns this

get

get(id: number): null | T

Implementation of ComponentManager.get
- Defined in ecs/src/classes/IndexedComponentManager.ts:119
Get the component of an entity by id.

Parameters
- id: number
  
  The id of the entity to get the component of.
Returns null | T

has

has(id: number): boolean

- Defined in ecs/src/classes/IndexedComponentManager.ts:110
Utility method for checking if an id has a registered component.

Parameters
- id: number
  
  THe id of the entity.
Returns boolean

isEmpty

isEmpty(): boolean

- Defined in ecs/src/classes/IndexedComponentManager.ts:86
Utility to get the emptyness of the manager. Usefull for testing.

Returns boolean

mutateMany

mutateMany(ids: number[]): this

- Defined in ecs/src/classes/IndexedComponentManager.ts:155
Mark entities as mutated.

Parameters
- ids: number[]
  
  The ids to emit.
Returns this

mutateOne

mutateOne(id: number): this

- Defined in ecs/src/classes/IndexedComponentManager.ts:168
Mark entity as mutated.

Parameters
- id: number
  
  The id to emit.
Returns this

registerEntity

registerEntity(id: number, component: T): this

Implementation of ComponentManager.registerEntity
- Defined in ecs/src/classes/IndexedComponentManager.ts:36
Add an entity to the manager.

Parameters
- id: number
  
  The id of the entity
- component: T
  
  The component to add.
Returns this

set

set(id: number, value: T, mutate?: boolean): this

- Defined in ecs/src/classes/IndexedComponentManager.ts:136
Set the value of an entity knowing it's id.

Parameters
- id: number
  
  The id of the entity.
- value: T
  
  The value of the entity.
- Default value mutate: boolean = true
  
  If set to true this will automatically emit the changed event.
Returns this

withMutation

withMutation(callback: function): this

- Defined in ecs/src/classes/IndexedComponentManager.ts:190
Runs callback and marks the return value as mutated.

Parameters
- callback: function
  
  The callback to run.
  - - (): number
    - Returns number
Returns this

withMutations

withMutations(callback: function): this

- Defined in ecs/src/classes/IndexedComponentManager.ts:179
Runs callback and marks the return value as mutated.

Parameters
- callback: function
  
  The callback to run.
  - - (): number[]
    - Returns number[]
Returns this

Generated using TypeDoc