Class EntityPool

Hierarchy

EntityPool

Constructors

constructor

Properties

Methods

Constructors

constructor

new EntityPool(options?: Partial<EntityPoolOptions>): EntityPool

- Defined in ecs/src/classes/EntityPool.ts:38
Class to keep track of alive entities Inspired by: http://bitsquid.blogspot.com/2014/08/building-data-oriented-entity-system.html

Parameters
- Default value options: Partial<EntityPoolOptions> = {}
  
  Options to be used by the ecs.
Returns EntityPool

Properties

Private generations

generations: Array<number> = []

Array with the generation of all avabile entities.

Private indexMask

indexMask: number

Bitmask for getting the index from an entity id.

Private options

options: Readonly<EntityPoolOptions>

The final set of options to be used by the ecs

Private recycleDeque

recycleDeque: Deque<number>

Deque with all the entities ready to be reused.

Methods

alive

alive(id: number): boolean

- Defined in ecs/src/classes/EntityPool.ts:78
Gets the state of an entity (alive / dead).

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

create

create(allowRecycling?: boolean): number

- Defined in ecs/src/classes/EntityPool.ts:58
Generates a new entity id.

Parameters
- Default value allowRecycling: boolean = true
  
  Allows recycling entities.
Returns number

destroy

destroy(id: number): void

- Defined in ecs/src/classes/EntityPool.ts:90
Destroys an entity and flags it for recycling.

Parameters
- id: number
  
  The id of the entity
Returns void

Generated using TypeDoc