Class StateMachine<TPossibleStates, TData>

Type Parameters

TPossibleStates extends string
TData

Hierarchy

StateMachine

Index

Constructors

Properties

data startState states

Accessors

Methods

go in restore save update create

Constructors

constructor

new StateMachine<TPossibleStates, TData>(): StateMachine<TPossibleStates, TData>
Type Parameters
- TPossibleStates extends string
- TData
Returns StateMachine<TPossibleStates, TData>

Properties

data

data: TData

startState

startState: State

states

states: Map<string, State> = ...

Accessors

currentState

get currentState(): State
Returns State
- Defined in Util/StateMachine.ts:26
set currentState(state: State): void
Parameters
- state: State
Returns void
- Defined in Util/StateMachine.ts:29

Methods

go

go(stateName: TPossibleStates, eventData?: any): boolean
Parameters
- stateName: TPossibleStates
- Optional eventData: any
Returns boolean
- Defined in Util/StateMachine.ts:67

in

in(state: TPossibleStates): boolean
Parameters
- state: TPossibleStates
Returns boolean
- Defined in Util/StateMachine.ts:63

restore

restore(saveKey: string): void
Parameters
- saveKey: string
Returns void
- Defined in Util/StateMachine.ts:106

save

save(saveKey: string): void
Parameters
- saveKey: string
Returns void
- Defined in Util/StateMachine.ts:99

update

update(elapsedMs: number): void
Parameters
- elapsedMs: number
Returns void
- Defined in Util/StateMachine.ts:93

`Static` create

create<TMachine, TData>(machineDescription: TMachine, data?: TData): StateMachine<PossibleStates<TMachine>, TData>
Type Parameters
- TMachine extends StateMachineDescription
- TData
Parameters
- machineDescription: TMachine
- Optional data: TData
Returns StateMachine<PossibleStates<TMachine>, TData>
- Defined in Util/StateMachine.ts:35