Class HierarchicalStateMachine<TContext>

Hierarchical state machine with composite states, event-driven transitions, timeout transitions, and state tags.

Usage:

const combat = new HierarchicalStateMachine(ctx, 'combat');
combat.addState('idle', { hooks: { ... } });
combat.addState('attacking', {
  tags: ['busy'],
  children: attackSubFSM,
  initialChild: 'windup',
});
combat.addEventTransition('idle', 'damage', { to: 'hitstun' });
combat.addTimeoutTransition('hitstun', { to: 'idle', durationMs: 500 });

Type Parameters

TContext = unknown

Constructors

constructor

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

Methods

addEventTransition

addEventTransition(
    fromState: string,
    eventType: string,
    def: EventTransitionDef<TContext>,
): this
Add an event-driven transition
Parameters
- fromState: string
- eventType: string
- def: EventTransitionDef<TContext>
Returns this
- Defined in packages/clik-engine/src/fsm/HierarchicalStateMachine.ts:88

addState

addState(name: string, config: HierarchicalStateConfig<TContext>): this
Add a state (optionally hierarchical with children)
Parameters
- name: string
- config: HierarchicalStateConfig<TContext>
Returns this
- Defined in packages/clik-engine/src/fsm/HierarchicalStateMachine.ts:73

addTimeoutTransition

addTimeoutTransition(fromState: string, def: TimeoutTransitionDef): this
Add a timeout-based transition: auto-transition after durationMs in fromState
Parameters
- fromState: string
- def: TimeoutTransitionDef
Returns this
- Defined in packages/clik-engine/src/fsm/HierarchicalStateMachine.ts:101

addTransition

addTransition(
    from: string,
    to: string,
    condition: (ctx: TContext) => boolean,
    guard?: (ctx: TContext) => boolean,
): this
Add a condition-based automatic transition
Parameters
- from: string
- to: string
- condition: (ctx: TContext) => boolean
- Optionalguard: (ctx: TContext) => boolean
Returns this
- Defined in packages/clik-engine/src/fsm/HierarchicalStateMachine.ts:79

getChildState

getChildState(): string | null
Get the active child state (if current state is composite)

Returns string | null
- Defined in packages/clik-engine/src/fsm/HierarchicalStateMachine.ts:221

getCurrent

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

getDebugState

getDebugState(): Record<string, unknown>
Returns Record<string, unknown>
- Defined in packages/clik-engine/src/fsm/HierarchicalStateMachine.ts:235

getHistory

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

getPrevious

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

getStateElapsed

getStateElapsed(): number
Get elapsed time in current state (ms)

Returns number
- Defined in packages/clik-engine/src/fsm/HierarchicalStateMachine.ts:187

getStatePath

getStatePath(): string
Get full state path (e.g., 'combat.attacking.windup')

Returns string
- Defined in packages/clik-engine/src/fsm/HierarchicalStateMachine.ts:228

getTags

getTags(): string[]
Get all tags from current state and children

Returns string[]
- Defined in packages/clik-engine/src/fsm/HierarchicalStateMachine.ts:211

hasTag

hasTag(tag: string): boolean
Check if current state (or any ancestor) has a tag
Parameters
- tag: string
Returns boolean
- Defined in packages/clik-engine/src/fsm/HierarchicalStateMachine.ts:200

is

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

isAny

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

sendEvent

sendEvent(event: FSMEvent): void
Send an event to the FSM
Parameters
- event: FSMEvent
Returns void
- Defined in packages/clik-engine/src/fsm/HierarchicalStateMachine.ts:153

start

start(initialState: string): this
Start the FSM
Parameters
- initialState: string
Returns this
- Defined in packages/clik-engine/src/fsm/HierarchicalStateMachine.ts:107

transitionTo

transitionTo(newState: string): boolean
Force a transition
Parameters
- newState: string
Returns boolean
- Defined in packages/clik-engine/src/fsm/HierarchicalStateMachine.ts:160

update

update(delta: number): void
Update the FSM
Parameters
- delta: number
Returns void
- Defined in packages/clik-engine/src/fsm/HierarchicalStateMachine.ts:117

Class HierarchicalStateMachine<TContext>

Type Parameters

Index

Constructors

Methods

Constructors

constructor

Type Parameters

Parameters

Returns HierarchicalStateMachine<TContext>

Methods

addEventTransition

Parameters

Returns this

addState

Parameters

Returns this

addTimeoutTransition

Parameters

Returns this

addTransition

Parameters

Returns this

getChildState

Returns string | null

getCurrent

Returns string | null

getDebugState

Returns Record<string, unknown>

getHistory

Returns readonly string[]

getPrevious

Returns string | null

getStateElapsed

Returns number

getStatePath

Returns string

getTags

Returns string[]

hasTag

Parameters

Returns boolean

is

Parameters

Returns boolean

isAny

Parameters

Returns boolean

sendEvent

Parameters

Returns void

start

Parameters

Returns this

transitionTo

Parameters

Returns boolean

update

Parameters

Returns void

Settings

On This Page