Class AnimationBinding<TContext>

Declarative two-way binding between a HierarchicalStateMachine and an AnimationStateMachine.

Usage:

const binding = new AnimationBinding(hfsm, asm);
binding.bind({ fsmState: 'idle', animState: 'idle' });
binding.bind({ fsmState: 'attack', animState: 'attack', onComplete: 'idle' });
// Call sync() after FSM transitions:
binding.sync();

Type Parameters

TContext = unknown

Index

Constructors

constructor

Methods

bind bindAll checkAnimationComplete clear getBinding getBoundStates sync

Constructors

constructor

new AnimationBinding<TContext = unknown>(
fsm: HierarchicalStateMachine<TContext>,
asm: AnimationStateMachine,
): AnimationBinding<TContext>
Type Parameters
- TContext = unknown
Parameters
- fsm: HierarchicalStateMachine<TContext>
- asm: AnimationStateMachine
Returns AnimationBinding<TContext>
- Defined in packages/clik-engine/src/fsm/AnimationBinding.ts:31

Methods

bind

bind(config: AnimBindingConfig): this
Bind an FSM state to an animation state
Parameters
- config: AnimBindingConfig
Returns this
- Defined in packages/clik-engine/src/fsm/AnimationBinding.ts:37

bindAll

bindAll(configs: AnimBindingConfig[]): this
Bind multiple at once
Parameters
- configs: AnimBindingConfig[]
Returns this
- Defined in packages/clik-engine/src/fsm/AnimationBinding.ts:43

checkAnimationComplete

checkAnimationComplete(): void
Check if animation completed and should trigger FSM transition. Call this each frame after sync().

Returns void
- Defined in packages/clik-engine/src/fsm/AnimationBinding.ts:69

clear

clear(): void
Clear all bindings

Returns void
- Defined in packages/clik-engine/src/fsm/AnimationBinding.ts:94

getBinding

getBinding(fsmState: string): AnimBindingConfig | undefined
Get the binding for an FSM state
Parameters
- fsmState: string
Returns AnimBindingConfig | undefined
- Defined in packages/clik-engine/src/fsm/AnimationBinding.ts:84

getBoundStates

getBoundStates(): string[]
Get all bound FSM state names

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

sync

sync(): void
Sync animation to FSM state. Call this each frame or after FSM transitions. Sets the animation state based on current FSM state.

Returns void
- Defined in packages/clik-engine/src/fsm/AnimationBinding.ts:54

Class AnimationBinding<TContext>

Type Parameters

Index

Constructors

Methods

Constructors

constructor

Type Parameters

Parameters

Returns AnimationBinding<TContext>

Methods

bind

Parameters

Returns this

bindAll

Parameters

Returns this

checkAnimationComplete

Returns void

clear

Returns void

getBinding

Parameters

Returns AnimBindingConfig | undefined

getBoundStates

Returns string[]

sync

Returns void

Settings

On This Page