Class RuntimeWorld

Hierarchy

RuntimeWorld

Implements

Constructors

constructor

new RuntimeWorld(name, config, $data?): RuntimeWorld
Parameters
- name: string
- config: IRuntimeWorldInitConfig
- Optional $data: Partial<IRuntimeWorldInitData>
Returns RuntimeWorld
- Defined in src/world/runtime/runtime-world.ts:74

Properties

addEntitiesToGroup

addEntitiesToGroup: ((this, groupHandle, entities) => void) = addEntitiesToGroup

Type declaration

- (this, groupHandle, entities): void
- Parameters
  - this: PreptimeWorld | RuntimeWorld
  - groupHandle: number
  - entities: IterableIterator<Readonly<IEntity>> | readonly Readonly<IEntity>[]
  Returns void

addEntity

addEntity: ((this, entity) => void) = addEntity

Type declaration

- (this, entity): void
- Parameters
  - this: RuntimeWorld
  - entity: Readonly<IEntity>
  Returns void

addEntityToGroup

addEntityToGroup: ((this, groupHandle, entity) => void) = addEntityToGroup

Type declaration

- (this, groupHandle, entity): void
- Parameters
  - this: PreptimeWorld | RuntimeWorld
  - groupHandle: number
  - entity: Readonly<IEntity>
  Returns void

addResource

addResource: (<T>(this, obj, ...args) => T) = addResource

Type declaration

- <T>(this, obj, ...args): T
- Type Parameters
  - T extends object
  Parameters
  - this: RuntimeWorld
  - obj: Readonly<T> | TTypeProto<T>
  - Rest ...args: readonly unknown[]
  Returns T

assimilateGroup

assimilateGroup: ((this, otherWorld, handle) => TGroupHandle) = assimilateGroup

Type declaration

- (this, otherWorld, handle): TGroupHandle
- Parameters
  - this: PreptimeWorld | RuntimeWorld
  - otherWorld: Readonly<IPreptimeWorld>
  - handle: number
  Returns TGroupHandle

buildEntity

buildEntity: ((this, uuid?) => IEntityBuilder) = buildEntity

Type declaration

- (this, uuid?): IEntityBuilder
- Parameters
  - this: IMutableWorld
  - Optional uuid: string
  Returns IEntityBuilder

clearEntities

clearEntities: ((this) => void) = clearEntities

Type declaration

- (this): void
- Parameters
  - this: Object
  Returns void

clearGroups

clearGroups: ((this) => void) = clearGroups

Type declaration

- (this): void
- Parameters
  - this: PreptimeWorld | RuntimeWorld
  Returns void

clearResources

clearResources: ((this) => void) = clearResources

Type declaration

- (this): void
- Parameters
  - this: PreptimeWorld | RuntimeWorld
  Returns void

config

config: IRuntimeWorldInitConfig

Initial config

createEntity

createEntity: ((this) => IEntity) = createEntity

Type declaration

- (this): IEntity
- Parameters
  - this: IMutableWorld
  Returns IEntity

createGroup

createGroup: ((this) => TGroupHandle) = createGroup

Type declaration

- (this): TGroupHandle
- Parameters
  - this: PreptimeWorld | RuntimeWorld
  Returns TGroupHandle

data

data: IRuntimeWorldData

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

`Readonly` eventBus

eventBus: EventBus = ...

Architecture to send messages between systems

getEntities

getEntities: ((this, query?) => IterableIterator<IEntity>) = getEntities

Type declaration

- (this, query?): IterableIterator<IEntity>
- Parameters
  - this: PreptimeWorld | RuntimeWorld
  - Optional query: Readonly<IEntitiesQuery>
  Returns IterableIterator<IEntity>

getGroupEntities

getGroupEntities: ((this, groupHandle) => IterableIterator<IEntity>) = getGroupEntities

Type declaration

- (this, groupHandle): IterableIterator<IEntity>
- Parameters
  - this: PreptimeWorld | RuntimeWorld
  - groupHandle: number
  Returns IterableIterator<IEntity>

getResource

getResource: (<T>(this, type) => T) = getResource

Type declaration

- <T>(this, type): T
- Type Parameters
  - T extends object
  Parameters
  - this: RuntimeWorld
  - type: TTypeProto<T>
  Returns T

getResources

getResources: ((this, types?) => IterableIterator<object>) = getResources

Type declaration

- (this, types?): IterableIterator<object>
- Parameters
  - this: PreptimeWorld | RuntimeWorld
  - Optional types: readonly TExistenceQueryParameter<any>[]
  Returns IterableIterator<object>

hasEntity

hasEntity: ((this, entity) => boolean) = hasEntity

Type declaration

- (this, entity): boolean
- Parameters
  - this: RuntimeWorld
  - entity: Readonly<IEntity>
  Returns boolean

hasResource

hasResource: (<T>(this, obj) => boolean) = hasResource

Type declaration

- <T>(this, obj): boolean
- Type Parameters
  - T extends object
  Parameters
  - this: PreptimeWorld | RuntimeWorld
  - obj: Readonly<T> | TTypeProto<T>
  Returns boolean

load

load: ((this, prefab, options?, intoGroup?) => TGroupHandle) = load

Type declaration

- (this, prefab, options?, intoGroup?): TGroupHandle
- Parameters
  - this: RuntimeWorld
  - prefab: Readonly<ISerialFormat>
  - Optional options: Readonly<ISerDeOptions<TDeserializer>>
  - Optional intoGroup: number
  Returns TGroupHandle

merge

merge: ((this, elsewhere, intoGroup?) => [TGroupHandle, IEntity[]]) = merge

Type declaration

- (this, elsewhere, intoGroup?): [TGroupHandle, IEntity[]]
- Parameters
  - this: Object
  - elsewhere: Readonly<IPreptimeWorld>
  - Optional intoGroup: number
  Returns [TGroupHandle, IEntity[]]

name

name: string

World's name

popState

popState: ((this) => Promise<void>) = popState

Type declaration

- (this): Promise<void>
- Parameters
  - this: RuntimeWorld
  Returns Promise<void>

pushState

pushState: ((this, NewState) => Promise<void>) = pushState

Type declaration

- (this, NewState): Promise<void>
- Parameters
  - this: RuntimeWorld
  - NewState: IIStateProto
  Returns Promise<void>

removeEntity

removeEntity: ((this, entity) => void) = removeEntity

Type declaration

- (this, entity): void
- Parameters
  - this: RuntimeWorld
  - entity: Readonly<IEntity>
  Returns void

removeGroup

removeGroup: ((this, groupHandle) => void) = removeGroup

Type declaration

- (this, groupHandle): void
- Parameters
  - this: Object
  - groupHandle: number
  Returns void

removeResource

removeResource: (<T>(this, type) => void) = removeResource

Type declaration

- <T>(this, type): void
- Type Parameters
  - T extends object
  Parameters
  - this: RuntimeWorld
  - type: TTypeProto<T>
  Returns void

replaceResource

replaceResource: (<T>(this, obj, ...args) => Promise<void>) = replaceResource

Type declaration

- <T>(this, obj, ...args): Promise<void>
- Type Parameters
  - T extends object
  Parameters
  - this: RuntimeWorld
  - obj: Readonly<T> | TTypeProto<T>
  - Rest ...args: readonly unknown[]
  Returns Promise<void>

save

save: ((this, options?) => ISerialFormat) = save

Type declaration

- (this, options?): ISerialFormat
- Parameters
  - this: RuntimeWorld
  - Optional options: Readonly<ISerDeOptions<TSerializer>>
  Returns ISerialFormat

Accessors

awaiter

get awaiter(): undefined | Promise<void>
This promise resolves when the execution terminates

Returns undefined | Promise<void>
Implementation of IRuntimeWorld.awaiter
- Defined in src/world/runtime/runtime-world.ts:146

currentState

get currentState(): undefined | Readonly<IState>
Advertises the current state

Returns undefined | Readonly<IState>
Implementation of IRuntimeWorld.currentState
- Defined in src/world/runtime/runtime-world.ts:150

isRunning

get isRunning(): boolean
Boolean indicator if the world is currently executing

Returns boolean
Implementation of IRuntimeWorld.isRunning
- Defined in src/world/runtime/runtime-world.ts:154

systemActions

get systemActions(): ISystemActions
Object containing all actions available inside a system

Returns ISystemActions
Implementation of IRuntimeWorld.systemActions
- Defined in src/world/runtime/runtime-world.ts:158

transitionActions

get transitionActions(): ITransitionActions
Object containing all actions available on step-to-step transitions, as well as to states

Returns ITransitionActions
Implementation of IRuntimeWorld.transitionActions
- Defined in src/world/runtime/runtime-world.ts:162

Methods

[dispose]

[dispose](): void
Returns void
- Defined in src/world/runtime/runtime-world.ts:336

flushCommands

flushCommands(): Promise<void>
Returns Promise<void>
- Defined in src/world/runtime/runtime-world.ts:166

hmrReplaceSystem

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

prepare

prepare(): Promise<void>
Returns Promise<void>
- Defined in src/world/runtime/runtime-world.ts:193

start

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

Returns Promise<void>
Implementation of IRuntimeWorld.start
- Defined in src/world/runtime/runtime-world.ts:226

step

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

Returns Promise<void>
Implementation of IRuntimeWorld.step
- Defined in src/world/runtime/runtime-world.ts:319

stop

stop(): void
Terminate execution

Returns void
Implementation of IRuntimeWorld.stop
- Defined in src/world/runtime/runtime-world.ts:331

Class RuntimeWorld

Hierarchy

Implements

Index

Constructors

Properties

Accessors

Methods

Constructors

constructor

Parameters

name: string

config: IRuntimeWorldInitConfig

Optional $data: Partial<IRuntimeWorldInitData>

Returns RuntimeWorld

Properties

addEntitiesToGroup

Type declaration

Parameters

this: PreptimeWorld | RuntimeWorld

groupHandle: number

entities: IterableIterator<Readonly<IEntity>> | readonly Readonly<IEntity>[]

Returns void

addEntity

Type declaration

Parameters

this: RuntimeWorld

entity: Readonly<IEntity>

Returns void

addEntityToGroup

Type declaration

Parameters

this: PreptimeWorld | RuntimeWorld

groupHandle: number

entity: Readonly<IEntity>

Returns void

addResource

Type declaration

Type Parameters

T extends object

Parameters

this: RuntimeWorld

obj: Readonly<T> | TTypeProto<T>

Rest ...args: readonly unknown[]

Returns T

assimilateGroup

Type declaration

Parameters

this: PreptimeWorld | RuntimeWorld

otherWorld: Readonly<IPreptimeWorld>

handle: number

Returns TGroupHandle

buildEntity

Type declaration

Parameters

this: IMutableWorld

Optional uuid: string

Returns IEntityBuilder

clearEntities

Type declaration

Parameters

this: Object

Returns void

clearGroups

Type declaration

Parameters

this: PreptimeWorld | RuntimeWorld

Returns void

clearResources

Type declaration

Parameters

this: PreptimeWorld | RuntimeWorld

Returns void

config

createEntity

Type declaration

Parameters

this: IMutableWorld

Returns IEntity

createGroup

`Optional` $data: Partial<IRuntimeWorldInitData>

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

`Optional` uuid: string

`Readonly` eventBus

`Optional` query: Readonly<IEntitiesQuery>

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

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

`Optional` intoGroup: number

`Optional` intoGroup: number