Class StateMachine<TContext>

Type Parameters

TContext = unknown

Index

Constructors

Methods

addState addTransition getCurrent getDebugState getHistory getPrevious is isAny start transitionTo update

Constructors

constructor

new StateMachine<TContext = unknown>(
context: TContext,
debugLabel?: string,
): StateMachine<TContext>
Type Parameters
- TContext = unknown
Parameters
- context: TContext
- debugLabel: string = 'fsm'
Returns StateMachine<TContext>
- Defined in packages/clik-engine/src/fsm/StateMachine.ts:14

Methods

addState

addState(name: string, hooks: StateHooks<TContext>): this
Parameters
- name: string
- hooks: StateHooks<TContext>
Returns this
- Defined in packages/clik-engine/src/fsm/StateMachine.ts:19

addTransition

addTransition(
    from: string,
    to: string,
    condition: (ctx: TContext) => boolean,
    guard?: (ctx: TContext) => boolean,
): this
Parameters
- from: string
- to: string
- condition: (ctx: TContext) => boolean
- Optionalguard: (ctx: TContext) => boolean
Returns this
- Defined in packages/clik-engine/src/fsm/StateMachine.ts:24

getCurrent

getCurrent(): string | null
Returns string | null
- Defined in packages/clik-engine/src/fsm/StateMachine.ts:94

getDebugState

getDebugState(): Record<string, unknown>
Get debug info for StateInspector

Returns Record<string, unknown>
- Defined in packages/clik-engine/src/fsm/StateMachine.ts:115

getHistory

getHistory(): readonly string[]
Returns readonly string[]
- Defined in packages/clik-engine/src/fsm/StateMachine.ts:102

getPrevious

getPrevious(): string | null
Returns string | null
- Defined in packages/clik-engine/src/fsm/StateMachine.ts:98

is

is(state: string): boolean
Parameters
- state: string
Returns boolean
- Defined in packages/clik-engine/src/fsm/StateMachine.ts:106

isAny

isAny(...states: string[]): boolean
Parameters
- ...states: string[]
Returns boolean
- Defined in packages/clik-engine/src/fsm/StateMachine.ts:110

start

start(initialState: string): this
Parameters
- initialState: string
Returns this
- Defined in packages/clik-engine/src/fsm/StateMachine.ts:32

transitionTo

transitionTo(newState: string): boolean
Parameters
- newState: string
Returns boolean
- Defined in packages/clik-engine/src/fsm/StateMachine.ts:68

update

update(delta: number): void
Parameters
- delta: number
Returns void
- Defined in packages/clik-engine/src/fsm/StateMachine.ts:48