Class WorldBuilder

constructor

• new WorldBuilder(serde: Readonly<ISerDe>): WorldBuilder

  Parameters

  • serde: Readonly<ISerDe>

  Returns WorldBuilder

c

component

components

name

r

resource

addCallback

• addCallback(cb: (world: Readonly<PreptimeWorld>) => void): WorldBuilder

  Parameters

  • cb: (world: Readonly<PreptimeWorld>) => void

  Returns WorldBuilder

build

• build(): PreptimeWorld

  Build the execution unit

  Returns PreptimeWorld

updateRootSyncPoint

• updateRootSyncPoint(updater: (root: ISyncPoint) => void): WorldBuilder

  Transform the root sync point

  Parameters

  • updater: (root: ISyncPoint) => void

  Returns WorldBuilder

withComponent

• withComponent(
      Component: TObjectProto,
      options?: Readonly<IObjectRegistrationOptions>,
  ): WorldBuilder

  Register a component in the world

  Parameters

  • Component: TObjectProto
  • Optionaloptions: Readonly<IObjectRegistrationOptions>

  Returns WorldBuilder

withComponents

• withComponents(...Components: readonly TObjectProto[]): WorldBuilder

  Register several components with default options in the world

  Parameters

  • ...Components: readonly TObjectProto[]

  Returns WorldBuilder

withDefaultScheduler

• withDefaultScheduler(scheduler: Readonly<IScheduler>): IWorldBuilder

  Add a default scheduler

  Parameters

  • scheduler: Readonly<IScheduler>

  Returns IWorldBuilder

withDefaultScheduling

• withDefaultScheduling(planner: (root: ISyncPoint) => void): WorldBuilder

  Create and add a default schedule

  Parameters

  • planner: (root: ISyncPoint) => void

  Returns WorldBuilder

withName

• withName(name: string): WorldBuilder

  Give the world a name

  Parameters

  • name: string

  Returns WorldBuilder

withResource

• withResource(
      Resource: TObjectProto,
      options?: Readonly<Partial<IResourceRegistrationOptions>>,
  ): WorldBuilder

  Register settings for a resource type (for serDe)

  Parameters

  • Resource: TObjectProto
  • Optionaloptions: Readonly<Partial<IResourceRegistrationOptions>>

  Returns WorldBuilder

withResources

• withResources(Resources: readonly TObjectProto[]): WorldBuilder

  Register several resources for serDe

  Parameters

  • Resources: readonly TObjectProto[]

  Returns WorldBuilder

withStateScheduler

• withStateScheduler(
      state: IIStateProto,
      scheduler: Readonly<IScheduler>,
  ): WorldBuilder

  Add a per-state custom scheduler

  Parameters

  • state: IIStateProto
  • scheduler: Readonly<IScheduler>

  Returns WorldBuilder

withStateScheduling

• withStateScheduling(
      state: IIStateProto,
      planner: (root: ISyncPoint) => void,
  ): WorldBuilder

  Create and add a per-state schedule

  Parameters

  • state: IIStateProto
  • planner: (root: ISyncPoint) => void

  Returns WorldBuilder