Class SystemBuilder<PARAMDESC>

Type Parameters

PARAMDESC extends TSystemParameterDesc

Hierarchy

SystemBuilder

Implements

ISystemBuilder<Readonly<PARAMDESC>>

Index

Constructors

Properties

parameterDesc runFunction setupFunction systemName

Methods

build name run setup withName withRunFunction withSetupFunction

Constructors

constructor

new SystemBuilder<PARAMDESC>(params): SystemBuilder<PARAMDESC>
Type Parameters
- PARAMDESC extends TSystemParameterDesc
Parameters
- params: Readonly<PARAMDESC>
Returns SystemBuilder<PARAMDESC>
- Defined in src/system/system-builder.ts:16

Properties

parameterDesc

parameterDesc: Readonly<PARAMDESC>

runFunction

runFunction: TSystemFunction<Readonly<PARAMDESC>> = ...

setupFunction

setupFunction: TSystemFunction<Readonly<PARAMDESC>> = ...

systemName

systemName: string = 'ECS_Unnamed_System'

Methods

build

build(): Readonly<ISystem<Readonly<PARAMDESC>>>
Build the system as defined in code

Returns Readonly<ISystem<Readonly<PARAMDESC>>>
Implementation of ISystemBuilder.build
- Defined in src/system/system-builder.ts:20

name

name(name): SystemBuilder<Readonly<PARAMDESC>>
Alias for [withName]ISystemBuilder#withName
Parameters
- name: string
Returns SystemBuilder<Readonly<PARAMDESC>>
Implementation of ISystemBuilder.name
- Defined in src/system/system-builder.ts:53

run

run(fn): SystemBuilder<Readonly<PARAMDESC>>
Alias for [withRunFunction]ISystemBuilder#withRunFunction
Parameters
- fn: TSystemFunction<Readonly<PARAMDESC>>
Returns SystemBuilder<Readonly<PARAMDESC>>
Implementation of ISystemBuilder.run
- Defined in src/system/system-builder.ts:57

setup

setup(fn): SystemBuilder<Readonly<PARAMDESC>>
Alias for [withSetupFunction]ISystemBuilder#withSetupFunction
Parameters
- fn: TSystemFunction<Readonly<PARAMDESC>>
Returns SystemBuilder<Readonly<PARAMDESC>>
Implementation of ISystemBuilder.setup
- Defined in src/system/system-builder.ts:61

withName

withName(name): SystemBuilder<Readonly<PARAMDESC>>
Give the system a name which is used for registration and error messages
Parameters
- name: string
Returns SystemBuilder<Readonly<PARAMDESC>>
Implementation of ISystemBuilder.withName
- Defined in src/system/system-builder.ts:65

withRunFunction

withRunFunction(fn): 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>>
Implementation of ISystemBuilder.withRunFunction
- Defined in src/system/system-builder.ts:70

withSetupFunction

withSetupFunction(fn): 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>>
Implementation of ISystemBuilder.withSetupFunction
- Defined in src/system/system-builder.ts:75

Generated using TypeDoc