Class EntityCommands

constructor

• new EntityCommands(world: World): EntityCommands

  Parameters

  • world: World

  Returns EntityCommands

world

build

• build(): EntityHandle

  Builds an entity with the components previously passed to EntityCommands.insert and EntityCommands.insertPrefab.

  Returns EntityHandle

clone

• clone(entity: EntityHandle): EntityHandle

  Clones an entity and its descendants.

  Parameters

  • entity: EntityHandle

  Returns EntityHandle

despawn

• despawn(entity: EntityHandle): void

  Parameters

  • entity: EntityHandle

  Returns void

entity

• entity(entity: EntityHandle): EntityCommands

  Parameters

  • entity: EntityHandle

  Returns EntityCommands

insert

• insert<T>(component: T): EntityCommands

  Inserts a component into a given entity.

  Type Parameters

  • T

  Parameters

  • component: T

  Returns EntityCommands

insertPrefab

• insertPrefab<T extends unknown[]>(components: [...T[]]): EntityCommands

  Type Parameters

  • T extends unknown[]

  Parameters

  • components: [...T[]]

  Returns EntityCommands

remove

• remove<T extends unknown[]>(
      entity: EntityHandle,
      components: TupleConstructor<T>,
  ): void

  Removes components from a given entity.

  Type Parameters

  • T extends unknown[]

  Parameters

  • entity: EntityHandle
  • components: TupleConstructor<T>

  Returns void

reparent

• reparent(entity: EntityHandle, parent?: EntityHandle): void

  Reparents an entity while preserving its world transform.

  Parameters

  • entity: EntityHandle
  • Optionalparent: EntityHandle = undefined

  Returns void

spawn

• spawn(): EntityCommands

  Returns EntityCommands

spawnBatch

• spawnBatch<T extends unknown[]>(batch: [...T[]][]): EntityHandle[]

  Type Parameters

  • T extends unknown[]

  Parameters

  • batch: [...T[]][]

  Returns EntityHandle[]