QueryManager

The query manager is responsible for updating all queries when entities/components change

Index

Constructors

• constructor

Methods

• addComponent
• addEntity
• addTag
• createQuery
• createTagQuery
• removeComponent
• removeEntity
• removeTag

Constructors

constructor

• new QueryManager(_world: World): QueryManager

• Parameters

  • _world: World

  Returns QueryManager

Methods

addComponent

• addComponent(entity: Entity<any>, component: Component): void

• Updates any queries when a component is added to an entity

  ---

  Parameters

  • entity: Entity<any>

  • component: Component

  Returns void

addEntity

• addEntity(entity: Entity<any>): void

• Scans queries and locates any that need this entity added

  ---

  Parameters

  • entity: Entity<any>

  Returns void

addTag

• addTag(entity: Entity<any>, tag: string): void

• Updates any queries when a tag is added to an entity

  ---

  Parameters

  • entity: Entity<any>

  • tag: string

  Returns void

publiccreateQuery

• createQuery<TKnownComponentCtors, TAnyComponentCtors>(params: TKnownComponentCtors[] | QueryParams<TKnownComponentCtors, TAnyComponentCtors>): Query<TKnownComponentCtors, TAnyComponentCtors>

• Type parameters

  • TKnownComponentCtors: ComponentCtor<Component> = never
  • TAnyComponentCtors: ComponentCtor<Component> = never

  Parameters

  • params: TKnownComponentCtors[] | QueryParams<TKnownComponentCtors, TAnyComponentCtors>

  Returns Query<TKnownComponentCtors, TAnyComponentCtors>

publiccreateTagQuery

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

• Type parameters

  • TKnownTags: string

  Parameters

  • requiredTags: TKnownTags[]

  Returns TagQuery<TKnownTags>

removeComponent

• removeComponent(entity: Entity<any>, component: Component): void

• Updates any queries when a component is removed from an entity

  ---

  Parameters

  • entity: Entity<any>

  • component: Component

  Returns void

removeEntity

• removeEntity(entity: Entity<any>): void

• Scans queries and locates any that need this entity removed

  ---

  Parameters

  • entity: Entity<any>

  Returns void

removeTag

• removeTag(entity: Entity<any>, tag: string): void

• Updates any queries when a component is removed from an entity

  ---

  Parameters

  • entity: Entity<any>

  • tag: string

  Returns void