Interface ISystemBuilder<PARAMDESC>

parameterDesc

runFunction

setupFunction

build

• build(): Readonly<ISystem<Readonly<PARAMDESC>>>

  Build the system as defined in code

  Returns Readonly<ISystem<Readonly<PARAMDESC>>>

name

• name(name: string): ISystemBuilder<Readonly<PARAMDESC>>

  Alias for [withName]ISystemBuilder#withName

  Parameters

  • name: string

  Returns ISystemBuilder<Readonly<PARAMDESC>>

run

• run(
      fn: TSystemFunction<Readonly<PARAMDESC>>,
  ): ISystemBuilder<Readonly<PARAMDESC>>

  Alias for [withRunFunction]ISystemBuilder#withRunFunction

  Parameters

  • fn: TSystemFunction<Readonly<PARAMDESC>>

  Returns ISystemBuilder<Readonly<PARAMDESC>>

setup

• setup(
      fn: TSystemFunction<Readonly<PARAMDESC>>,
  ): ISystemBuilder<Readonly<PARAMDESC>>

  Alias for [withSetupFunction]ISystemBuilder#withSetupFunction

  Parameters

  • fn: TSystemFunction<Readonly<PARAMDESC>>

  Returns ISystemBuilder<Readonly<PARAMDESC>>

withName

• withName(name: string): ISystemBuilder<Readonly<PARAMDESC>>

  Give the system a name which is used for registration and error messages

  Parameters

  • name: string

  Returns ISystemBuilder<Readonly<PARAMDESC>>

withRunFunction

• withRunFunction(
      fn: TSystemFunction<Readonly<PARAMDESC>>,
  ): ISystemBuilder<Readonly<PARAMDESC>>

  Add an executor to the system which is called on every relevant step

  Parameters

  • fn: TSystemFunction<Readonly<PARAMDESC>>

  Returns ISystemBuilder<Readonly<PARAMDESC>>

withSetupFunction

• withSetupFunction(
      fn: TSystemFunction<Readonly<PARAMDESC>>,
  ): ISystemBuilder<Readonly<PARAMDESC>>

  Add a setup function which is called when the system is instantiated (e.g. on a new world run)

  Parameters

  • fn: TSystemFunction<Readonly<PARAMDESC>>

  Returns ISystemBuilder<Readonly<PARAMDESC>>