Class SystemBuilder<PARAMDESC>

constructor

• new SystemBuilder<PARAMDESC extends TSystemParameterDesc>(
      params: Readonly<PARAMDESC>,
  ): SystemBuilder<PARAMDESC>

  Type Parameters

  • PARAMDESC extends TSystemParameterDesc

  Parameters

  • params: Readonly<PARAMDESC>

  Returns SystemBuilder<PARAMDESC>

name

parameterDesc

run

runFunction

setup

setupFunction

systemName

build

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

  Build the system as defined in code

  Returns Readonly<ISystem<Readonly<PARAMDESC>>>

withName

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

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

  Parameters

  • name: string

  Returns SystemBuilder<Readonly<PARAMDESC>>

withRunFunction

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

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

  Parameters

  • fn: TSystemFunction<Readonly<PARAMDESC>>

  Returns SystemBuilder<Readonly<PARAMDESC>>

withSetupFunction

• withSetupFunction(
      fn: TSystemFunction<Readonly<PARAMDESC>>,
  ): SystemBuilder<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 SystemBuilder<Readonly<PARAMDESC>>