Class AnimationStateMachine

Animation-specific state machine with cancel windows, priority levels, and per-edge transition types.

Usage:

const asm = new AnimationStateMachine(sprite);
asm.addState('idle', { animKey: 'player_idle', loop: true, priority: 0 });
asm.addState('attack', { animKey: 'player_attack', priority: 2, cancelAfterFrame: 4, next: 'idle' });
asm.addTransition('idle', 'attack', { type: 'cut' });
asm.start('idle');

Index

Constructors

constructor

Methods

addState addTransition canCancel canTransitionTo destroy forceState getCurrent getCurrentFrame getStateConfig setState start

Constructors

constructor

new AnimationStateMachine(
sprite: Phaser.GameObjects.Sprite,
): AnimationStateMachine
Parameters
- sprite: Phaser.GameObjects.Sprite
Returns AnimationStateMachine
- Defined in packages/clik-engine/src/animation/AnimationStateMachine.ts:47

Methods

addState

addState(name: string, config: AnimStateConfig): this
Register an animation state
Parameters
- name: string
- config: AnimStateConfig
Returns this
- Defined in packages/clik-engine/src/animation/AnimationStateMachine.ts:52

addTransition

addTransition(from: string, to: string, config?: AnimTransitionConfig): this
Register a transition between two states
Parameters
- from: string
- to: string
- Optionalconfig: AnimTransitionConfig
Returns this
- Defined in packages/clik-engine/src/animation/AnimationStateMachine.ts:63

canCancel

canCancel(): boolean
Check if the current state can be cancelled right now

Returns boolean
- Defined in packages/clik-engine/src/animation/AnimationStateMachine.ts:117

canTransitionTo

canTransitionTo(target: string): boolean
Check if a transition from current state to target is allowed
Parameters
- target: string
Returns boolean
- Defined in packages/clik-engine/src/animation/AnimationStateMachine.ts:125

destroy

destroy(): void
Clean up listeners

Returns void
- Defined in packages/clik-engine/src/animation/AnimationStateMachine.ts:148

forceState

forceState(name: string): void
Force a state change, ignoring priority and cancel windows
Parameters
- name: string
Returns void
- Defined in packages/clik-engine/src/animation/AnimationStateMachine.ts:101

getCurrent

getCurrent(): string | null
Get the current state name

Returns string | null
- Defined in packages/clik-engine/src/animation/AnimationStateMachine.ts:107

getCurrentFrame

getCurrentFrame(): number
Get the current animation frame index

Returns number
- Defined in packages/clik-engine/src/animation/AnimationStateMachine.ts:112

getStateConfig

getStateConfig(name: string): AnimStateConfig | undefined
Get the config for a state
Parameters
- name: string
Returns AnimStateConfig | undefined
- Defined in packages/clik-engine/src/animation/AnimationStateMachine.ts:143

setState

setState(name: string): boolean
Request a state change. Respects priority levels and cancel windows. Returns true if the transition was accepted.
Parameters
- name: string
Returns boolean
- Defined in packages/clik-engine/src/animation/AnimationStateMachine.ts:77

start

start(stateName: string): void
Start the state machine in a given state
Parameters
- stateName: string
Returns void
- Defined in packages/clik-engine/src/animation/AnimationStateMachine.ts:69

Class AnimationStateMachine

Index

Constructors

Methods

Constructors

constructor

Parameters

Returns AnimationStateMachine

Methods

addState

Parameters

Returns this

addTransition

Parameters

Returns this

canCancel

Returns boolean

canTransitionTo

Parameters

Returns boolean

destroy

Returns void

forceState

Parameters

Returns void

getCurrent

Returns string | null

getCurrentFrame

Returns number

getStateConfig

Parameters

Returns AnimStateConfig | undefined

setState

Parameters

Returns boolean

start

Parameters

Returns void

Settings

On This Page