Interface IRuntimeWorld

Hierarchy

IImmutableWorld
- IRuntimeWorld

Implemented by

RuntimeWorld

Properties

`Optional` `Readonly` awaiter

awaiter?: Promise<void>

This promise resolves when the execution terminates

`Readonly` config

config: Readonly<IRuntimeWorldInitConfig>

Initial config

`Readonly` currentState

currentState: undefined | Readonly<IState>

Advertises the current state

data

data: Readonly<IRuntimeWorldData>

Data to operate on. This data may mutate at any time

`Readonly` eventBus

eventBus: Readonly<IEventBus>

Architecture to send messages between systems

`Readonly` isRunning

isRunning: boolean

Boolean indicator if the world is currently executing

`Readonly` name

name: string

World's name

`Readonly` systemActions

systemActions: Readonly<ISystemActions>

Object containing all actions available inside a system

`Readonly` transitionActions

transitionActions: Readonly<ITransitionActions>

Object containing all actions available on step-to-step transitions, as well as to states

Methods

getEntities

getEntities(query?): IterableIterator<IEntity>
Query entities and find the ones with a certain combination of component. To get a single entity by ID, please use the global function getEntity()
Parameters
- Optional query: Readonly<IEntitiesQuery>
Returns IterableIterator<IEntity>
Inherited from IImmutableWorld.getEntities
- Defined in src/world/world.spec.ts:25

getGroupEntities

getGroupEntities(groupHandle): IterableIterator<IEntity>
Get all entities associated with a group
Parameters
- groupHandle: number
Returns IterableIterator<IEntity>
Inherited from IImmutableWorld.getGroupEntities
- Defined in src/world/world.spec.ts:42

getResource

getResource<T>(type): T
Get a resource which was previously stored
Type Parameters
- T extends object
Parameters
- type: TTypeProto<T>
Returns T
Inherited from IImmutableWorld.getResource
- Defined in src/world/world.spec.ts:65

getResources

getResources(types?): IterableIterator<object>
Get all resources stored in this world. Useful for debugging
Parameters
- Optional types: readonly TExistenceQueryParameter<any>[]
Returns IterableIterator<object>
Inherited from IImmutableWorld.getResources
- Defined in src/world/world.spec.ts:71

hasEntity

hasEntity(entity): boolean
Check whether an entity exists in this world
Parameters
- entity: Readonly<IEntity>
Returns boolean
Inherited from IImmutableWorld.hasEntity
- Defined in src/world/world.spec.ts:31

hasResource

hasResource<T>(type): boolean
Check if a resource was stored
Type Parameters
- T extends object
Parameters
- type: T | TTypeProto<T>
Returns boolean
Inherited from IImmutableWorld.hasResource
- Defined in src/world/world.spec.ts:77

hmrReplaceSystem

hmrReplaceSystem(newSystem): void
Hot replace a system
Parameters
- newSystem: ISystem<TSystemParameterDesc>
Returns void
- Defined in src/world/runtime/runtime-world.spec.ts:87

replaceResource

replaceResource<T>(obj, ...args): Promise<void>
Replace a resource from this world with a new value
Type Parameters
- T extends object
Parameters
- obj: T | TTypeProto<T>
- Rest ...args: readonly unknown[]
Returns Promise<void>
- Defined in src/world/runtime/runtime-world.spec.ts:94

save

save(options?): ISerialFormat
Prepare a savable version of the current world. The query can be used to only save a sub-set with specific conditions
Parameters
- Optional options: Readonly<ISerDeOptions<TSerializer>>
Returns ISerialFormat
Inherited from IImmutableWorld.save
- Defined in src/world/world.spec.ts:54

start

start(): Promise<void>
Start a continuous execution. The Promise resolves when the execution terminates

Returns Promise<void>
- Defined in src/world/runtime/runtime-world.spec.ts:100

step

step(): Promise<void>
Execute a single step. The Promise resolves when the execution terminates

Returns Promise<void>
- Defined in src/world/runtime/runtime-world.spec.ts:106

stop

stop(): void
Terminate execution

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

Interface IRuntimeWorld

Hierarchy

Implemented by

Index

Properties

Methods

Properties

Optional Readonly awaiter

Readonly config

Readonly currentState

data

Readonly eventBus

Readonly isRunning

Readonly name

Readonly systemActions

Readonly transitionActions

Methods

getEntities

Parameters

Optional query: Readonly<IEntitiesQuery>

Returns IterableIterator<IEntity>

getGroupEntities

Parameters

groupHandle: number

Returns IterableIterator<IEntity>

getResource

Type Parameters

T extends object

Parameters

type: TTypeProto<T>

Returns T

getResources

Parameters

Optional types: readonly TExistenceQueryParameter<any>[]

Returns IterableIterator<object>

hasEntity

Parameters

entity: Readonly<IEntity>

Returns boolean

hasResource

Type Parameters

T extends object

Parameters

type: T | TTypeProto<T>

Returns boolean

hmrReplaceSystem

Parameters

newSystem: ISystem<TSystemParameterDesc>

Returns void

replaceResource

Type Parameters

T extends object

Parameters

obj: T | TTypeProto<T>

Rest ...args: readonly unknown[]

Returns Promise<void>

save

Parameters

Optional options: Readonly<ISerDeOptions<TSerializer>>

Returns ISerialFormat

start

Returns Promise<void>

step

Returns Promise<void>

stop

Returns void

Settings

Member Visibility

Theme

On This Page

`Optional` `Readonly` awaiter

`Readonly` config

`Readonly` currentState

`Readonly` eventBus

`Readonly` isRunning

`Readonly` name

`Readonly` systemActions

`Readonly` transitionActions

`Optional` query: Readonly<IEntitiesQuery>

`Optional` types: readonly TExistenceQueryParameter<any>[]

`Rest` ...args: readonly unknown[]

`Optional` options: Readonly<ISerDeOptions<TSerializer>>