Interface ICommands

Commands is an async interface, which aggregates commands for later execution. The primary usage is to issue commands during system runtime and have them take effect on a common sync point, like after all systems ran

Hierarchy

ICommands

Index

Methods

addEntity addResource buildEntity clearEntities load merge mutateEntity popState pushState queueCommand removeEntity removeGroup removeResource replaceResource stopRun

Methods

addEntity

addEntity(entity): void
Add an entity to the world
Parameters
- entity: Readonly<IEntity>
Returns void
- Defined in src/world/runtime/commands/commands.spec.ts:23

addResource

addResource<T>(type, ...args): T
Add a resource to this world and returns the resource instance
Type Parameters
- T extends object
Parameters
- type: T | TTypeProto<T>
- Rest ...args: readonly unknown[]
  
  constructor parameters
Returns T
- Defined in src/world/runtime/commands/commands.spec.ts:30

buildEntity

buildEntity(): ICommandEntityBuilder
Build an entity and add it to this world using an entity builder

Returns ICommandEntityBuilder
- Defined in src/world/runtime/commands/commands.spec.ts:35

clearEntities

clearEntities(): void
Remove all entities from this world

Returns void
- Defined in src/world/runtime/commands/commands.spec.ts:40

load

load(prefab, options?): number
Load entities with components from a prefab or save
Parameters
- prefab: Readonly<ISerialFormat>
- Optional options: Readonly<ISerDeOptions<TDeserializer>>
Returns number
- Defined in src/world/runtime/commands/commands.spec.ts:47

merge

merge(world): number
Merge entities from another world into this one
Parameters
- world: Readonly<IWorld>
Returns number
- Defined in src/world/runtime/commands/commands.spec.ts:53

mutateEntity

mutateEntity(entity, mutator): void
Provides an environment to securely change an entity's data
Parameters
- entity: Readonly<IReadOnlyEntity>
- mutator: ((entity) => void | Promise<void>)
  - - (entity): void | Promise<void>
    - Parameters
      
      entity: IEntity
      
      Returns void | Promise<void>
Returns void
- Defined in src/world/runtime/commands/commands.spec.ts:60

popState

popState(): void
Revert the running world to a previous state

Returns void
- Defined in src/world/runtime/commands/commands.spec.ts:65

pushState

pushState(NewState): void
Change the running world to a new state
Parameters
- NewState: IIStateProto
Returns void
- Defined in src/world/runtime/commands/commands.spec.ts:71

queueCommand

queueCommand(command): void
Queue custom command for execution
Parameters
- command: TCommand
Returns void
- Defined in src/world/runtime/commands/commands.spec.ts:77

removeEntity

removeEntity(entity): void
Remove an entity from the world, deleting all of its components
Parameters
- entity: Readonly<IEntity>
Returns void
- Defined in src/world/runtime/commands/commands.spec.ts:83

removeGroup

removeGroup(handle): void
Remove a group and all entities inside from this world
Parameters
- handle: number
Returns void
- Defined in src/world/runtime/commands/commands.spec.ts:89

removeResource

removeResource<T>(type): void
Remove a resource from the world
Type Parameters
- T extends object
Parameters
- type: TTypeProto<T>
Returns void
- Defined in src/world/runtime/commands/commands.spec.ts:95

replaceResource

replaceResource<T>(type, ...args): void
Replace a resource from this world
Type Parameters
- T extends object
Parameters
- type: T | TTypeProto<T>
- Rest ...args: unknown[]
  
  constructor parameters
Returns void
- Defined in src/world/runtime/commands/commands.spec.ts:102

stopRun

stopRun(): void
Signal the world to stop its dispatch-loop

Returns void
- Defined in src/world/runtime/commands/commands.spec.ts:107

Generated using TypeDoc