Class TemplateStateMachine<EventPayloadMapping, Context, States>

This is the template for the state machine.

You can use this class to create a state machine. Usually this is all you need for the state machine. Unless you need extra functionality. To create a state machine, just instantiate this class and pass in the states, initial state and context.

See

createKmtInputStateMachine for an example of how to create a state machine.

Type Parameters

  • EventPayloadMapping
  • Context extends BaseContext
  • States extends string = "IDLE"

Hierarchy (View Summary)

Implements

Constructors

constructor

Properties

_context _currentState _happensCallbacks _stateChangeCallbacks _states _statesArray

Accessors

currentState possibleStates states

Methods

happens onHappens onStateChange setContext switchTo

Constructors

constructor

Properties

Protected_context

_context: Context

Protected_currentState

_currentState: States

Protected_happensCallbacks

_happensCallbacks: (
    event: keyof EventPayloadMapping,
    payload: EventPayloadMapping[keyof EventPayloadMapping],
    context: Context,
) => void[]

Protected_stateChangeCallbacks

_stateChangeCallbacks: StateChangeCallback<States>[]

Protected_states

_states: Record<States, State<EventPayloadMapping, Context, States>>

Protected_statesArray

_statesArray: States[]

Accessors

currentState

possibleStates

states

Methods

happens

onHappens

onStateChange

setContext

switchTo

Settings

Member Visibility

On This Page

Constructors
Properties
Accessors
Methods