Class WorldBuilder

Hierarchy

WorldBuilder

Implements

IWorldBuilder

Index

Constructors

Properties

c component components name r resource

Methods

addCallback build updateRootSyncPoint withComponent withComponents withDefaultScheduler withDefaultScheduling withName withResource withResources withStateScheduler withStateScheduling

Constructors

constructor

new WorldBuilder(serde): WorldBuilder
Parameters
- serde: Readonly<ISerDe>
Returns WorldBuilder
- Defined in src/world/world-builder.ts:24

Properties

c

c: ((Component, options?) => WorldBuilder) = ...

Type declaration

- (Component, options?): WorldBuilder
- Parameters
  - Component: TObjectProto
  - Optional options: Readonly<IObjectRegistrationOptions>
  Returns WorldBuilder

component

component: ((Component, options?) => WorldBuilder) = ...

Type declaration

- (Component, options?): WorldBuilder
- Parameters
  - Component: TObjectProto
  - Optional options: Readonly<IObjectRegistrationOptions>
  Returns WorldBuilder

components

components: ((...Components) => WorldBuilder) = ...

Type declaration

- (...Components): WorldBuilder
- Parameters
  - Rest ...Components: readonly TObjectProto[]
  Returns WorldBuilder

name

name: ((name) => WorldBuilder) = ...

Type declaration

- (name): WorldBuilder
- Parameters
  - name: string
  Returns WorldBuilder

r

r: ((Resource, options?) => WorldBuilder) = ...

Type declaration

- (Resource, options?): WorldBuilder
- Parameters
  - Resource: TObjectProto
  - Optional options: Readonly<Partial<IResourceRegistrationOptions>>
  Returns WorldBuilder

resource

resource: ((Resource, options?) => WorldBuilder) = ...

Type declaration

- (Resource, options?): WorldBuilder
- Parameters
  - Resource: TObjectProto
  - Optional options: Readonly<Partial<IResourceRegistrationOptions>>
  Returns WorldBuilder

Methods

addCallback

addCallback(cb): WorldBuilder
Parameters
- cb: ((world) => void)
  - - (world): void
    - Parameters
      
      world: Readonly<PreptimeWorld>
      
      Returns void
Returns WorldBuilder
- Defined in src/world/world-builder.ts:28

build

build(): PreptimeWorld
Build the execution unit

Returns PreptimeWorld
Implementation of IWorldBuilder.build
- Defined in src/world/world-builder.ts:33

updateRootSyncPoint

updateRootSyncPoint(updater): WorldBuilder
Transform the root sync point
Parameters
- updater: ((root) => void)
  - - (root): void
    - Parameters
      
      root: ISyncPoint
      
      Returns void
Returns WorldBuilder
Implementation of IWorldBuilder.updateRootSyncPoint
- Defined in src/world/world-builder.ts:116

withComponent

withComponent(Component, options?): WorldBuilder
Register a component in the world
Parameters
- Component: TObjectProto
- Optional options: Readonly<IObjectRegistrationOptions>
Returns WorldBuilder
Implementation of IWorldBuilder.withComponent
- Defined in src/world/world-builder.ts:121

withComponents

withComponents(...Components): WorldBuilder
Register several components with default options in the world
Parameters
- Rest ...Components: readonly TObjectProto[]
Returns WorldBuilder
Implementation of IWorldBuilder.withComponents
- Defined in src/world/world-builder.ts:131

withDefaultScheduler

withDefaultScheduler(scheduler): IWorldBuilder
Add a default scheduler
Parameters
- scheduler: Readonly<IScheduler>
Returns IWorldBuilder
Implementation of IWorldBuilder.withDefaultScheduler
- Defined in src/world/world-builder.ts:139

withDefaultScheduling

withDefaultScheduling(planner): WorldBuilder
Create and add a default schedule
Parameters
- planner: ((root) => void)
  - - (root): void
    - Parameters
      
      root: ISyncPoint
      
      Returns void
Returns WorldBuilder
Implementation of IWorldBuilder.withDefaultScheduling
- Defined in src/world/world-builder.ts:149

withName

withName(name): WorldBuilder
Give the world a name
Parameters
- name: string
Returns WorldBuilder
Implementation of IWorldBuilder.withName
- Defined in src/world/world-builder.ts:159

withResource

withResource(Resource, options?): WorldBuilder
Register settings for a resource type (for serDe)
Parameters
- Resource: TObjectProto
- Optional options: Readonly<Partial<IResourceRegistrationOptions>>
Returns WorldBuilder
Implementation of IWorldBuilder.withResource
- Defined in src/world/world-builder.ts:164

withResources

withResources(Resources): WorldBuilder
Register several resources for serDe
Parameters
- Resources: readonly TObjectProto[]
Returns WorldBuilder
Implementation of IWorldBuilder.withResources
- Defined in src/world/world-builder.ts:175

withStateScheduler

withStateScheduler(state, scheduler): WorldBuilder
Add a per-state custom scheduler
Parameters
- state: IIStateProto
- scheduler: Readonly<IScheduler>
Returns WorldBuilder
Implementation of IWorldBuilder.withStateScheduler
- Defined in src/world/world-builder.ts:183

withStateScheduling

withStateScheduling(state, planner): WorldBuilder
Create and add a per-state schedule
Parameters
- state: IIStateProto
- planner: ((root) => void)
  - - (root): void
    - Parameters
      
      root: ISyncPoint
      
      Returns void
Returns WorldBuilder
Implementation of IWorldBuilder.withStateScheduling
- Defined in src/world/world-builder.ts:199

Generated using TypeDoc