World

The World is a self-contained entity component system for a particular context.

Index

Constructors

• constructor

Properties

• entityManager
• queryManager
• scene
• systemManager

Accessors

• entities

Methods

• add
• clearEntities
• clearSystems
• get
• query
• queryTags
• remove
• update

Constructors

constructor

• new World(scene: Scene<unknown>): World

• The context type is passed to the system updates

  ---

  Parameters

  • scene: Scene<unknown>

  Returns World

Properties

publicentityManager

entityManager: EntityManager = ...

publicqueryManager

queryManager: QueryManager = ...

publicscene

scene: Scene<unknown>

publicsystemManager

systemManager: SystemManager = ...

Accessors

entities

• get entities(): Entity<any>[]

• Returns Entity<any>[]

Methods

add

• add(entity: Entity<any>): void
• add(system: System): void
• add(system: SystemCtor<System>): void

• Add an entity to the ECS world

  ---

  Parameters

  • entity: Entity<any>

  Returns void

clearEntities

• clearEntities(): void

• Returns void

clearSystems

• clearSystems(): void

• Returns void

get

• get(system: SystemCtor<System>): System

• Get a system out of the ECS world

  ---

  Parameters

  • system: SystemCtor<System>

  Returns System

query

• query<TKnownComponentCtors>(requiredTypes: TKnownComponentCtors[]): Query<TKnownComponentCtors>

• Query the ECS world for entities that match your components

  ---

  Type parameters

  • TKnownComponentCtors: ComponentCtor<Component>

  Parameters

  • requiredTypes: TKnownComponentCtors[]

  Returns Query<TKnownComponentCtors>

queryTags

• queryTags<TKnownTags>(requiredTags: TKnownTags[]): TagQuery<TKnownTags>

• Type parameters

  • TKnownTags: string

  Parameters

  • requiredTags: TKnownTags[]

  Returns TagQuery<TKnownTags>

remove

• remove(entity: Entity<any>, deferred?: boolean): void
• remove(system: System): void

• Remove an entity from the ECS world

  ---

  Parameters

  • entity: Entity<any>

  • optionaldeferred: boolean

  Returns void

update

• update(type: SystemType, elapsedMs: number): void

• Update systems by type and time elapsed in milliseconds

  ---

  Parameters

  • type: SystemType

  • elapsedMs: number

  Returns void