Class Archetype

Hierarchy

Archetype

Index

Constructors

Properties

bitfield candidateCache components entered entities exited isDirty

Accessors

Methods

addEntity clone isCandidate refresh removeEntity toString

Constructors

constructor

new Archetype(size: number, components: ComponentInstance<any>[], bitfield?: Bitfield): Archetype
Parameters
- size: number
- components: ComponentInstance<any>[]
- Optional bitfield: Bitfield
Returns Archetype
- Defined in src/archetype/archetype.ts:24

Properties

`Readonly` bitfield

bitfield: Bitfield

The Archetype's Component Bitfield

`Readonly` candidateCache

candidateCache: Map<QueryInstance, boolean>

QueryInstances and their candidacy status

`Readonly` components

components: ComponentInstance<any>[]

The components associated with this archetype

`Readonly` entered

entered: Set<Entity>

Entities which have entered this archetype since last refresh

`Readonly` entities

entities: Set<Entity>

Set of Entities which inhabit this Archetype

`Readonly` exited

exited: Set<Entity>

Entities which have exited this archetype since last refresh

isDirty

isDirty: boolean

true if the object is in a dirty state

Accessors

id

get id(): string
The Archetype's unique identifier

Returns string
- Defined in src/archetype/archetype.ts:35

isEmpty

get isEmpty(): boolean
true if this Archetype has no entities associated with it

Returns boolean
- Defined in src/archetype/archetype.ts:40

Methods

addEntity

addEntity(entity: Entity): Archetype
Add an Entity to the Archetype
Parameters
- entity: Entity
Returns Archetype
- Defined in src/archetype/archetype.ts:45

clone

clone(): Archetype
Create a new Archetype from this Archetype

Returns Archetype
- Defined in src/archetype/archetype.ts:53

isCandidate

isCandidate(query: QueryInstance): boolean
Test this Archetype matches a given QueryInstance

Returns
true if the QueryInstance is a match
Parameters
- query: QueryInstance
  
  The QueryInstance to test
Returns boolean
- Defined in src/archetype/archetype.ts:62

refresh

refresh(): Archetype
Clear entered/exited entities and set isDirty to false

Returns Archetype
- Defined in src/archetype/archetype.ts:71

removeEntity

removeEntity(entity: Entity): Archetype
Remove an Entity from the Archetype
Parameters
- entity: Entity
Returns Archetype
- Defined in src/archetype/archetype.ts:79

toString

toString(): string
Serialize the Archetype to a string

Returns string
- Defined in src/archetype/archetype.ts:87

Generated using TypeDoc