Class AnimatorComponent

Entity component wrapping AnimationStateMachine. Provides a sprite and animation state machine on an entity.

Usage:

const animator = new AnimatorComponent(sprite);
animator.addState('idle', { animKey: 'player_idle', loop: true, priority: 0 });
animator.addState('run', { animKey: 'player_run', loop: true, priority: 1 });
entity.addComponent('animator', animator);
animator.start('idle');

Hierarchy (View Summary)

Component
- AnimatorComponent

Index

Constructors

constructor

new AnimatorComponent(sprite: Phaser.GameObjects.Sprite): AnimatorComponent
Parameters
- sprite: Phaser.GameObjects.Sprite
Returns AnimatorComponent
Overrides Component.constructor
- Defined in packages/clik-engine/src/entity/components/AnimatorComponent.ts:23

Properties

enabled

enabled: boolean = true

entity

entity: Entity

Methods

addState

addState(name: string, config: AnimStateConfig): this
Add an animation state
Parameters
- name: string
- config: AnimStateConfig
Returns this
- Defined in packages/clik-engine/src/entity/components/AnimatorComponent.ts:30

addTransition

addTransition(from: string, to: string, config?: AnimTransitionConfig): this
Add a transition between states
Parameters
- from: string
- to: string
- Optionalconfig: AnimTransitionConfig
Returns this
- Defined in packages/clik-engine/src/entity/components/AnimatorComponent.ts:36

canCancel

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

Returns boolean
- Defined in packages/clik-engine/src/entity/components/AnimatorComponent.ts:67

canTransitionTo

canTransitionTo(target: string): boolean
Check if transition to target is possible
Parameters
- target: string
Returns boolean
- Defined in packages/clik-engine/src/entity/components/AnimatorComponent.ts:72

forceState

forceState(name: string): void
Force a state change
Parameters
- name: string
Returns void
- Defined in packages/clik-engine/src/entity/components/AnimatorComponent.ts:52

getCurrent

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

Returns string | null
- Defined in packages/clik-engine/src/entity/components/AnimatorComponent.ts:57

getCurrentFrame

getCurrentFrame(): number
Get current frame index

Returns number
- Defined in packages/clik-engine/src/entity/components/AnimatorComponent.ts:62

getSprite

getSprite(): Phaser.GameObjects.Sprite
Get the sprite

Returns Phaser.GameObjects.Sprite
- Defined in packages/clik-engine/src/entity/components/AnimatorComponent.ts:82

getStateMachine

getStateMachine(): AnimationStateMachine
Get the underlying AnimationStateMachine

Returns AnimationStateMachine
- Defined in packages/clik-engine/src/entity/components/AnimatorComponent.ts:77

onAttach

onAttach(): void
Called when the component is added to an entity

Returns void
Inherited from Component.onAttach
- Defined in packages/clik-engine/src/entity/Component.ts:8

onDetach

onDetach(): void
Called when the component is removed or entity is destroyed

Returns void
Overrides Component.onDetach
- Defined in packages/clik-engine/src/entity/components/AnimatorComponent.ts:90

reset

reset(): void
Called when the owning entity is recycled from a pool. Reset internal state to defaults.

Returns void
Overrides Component.reset
- Defined in packages/clik-engine/src/entity/components/AnimatorComponent.ts:86

setState

setState(name: string): boolean
Request a state change (respects priority and cancel windows)
Parameters
- name: string
Returns boolean
- Defined in packages/clik-engine/src/entity/components/AnimatorComponent.ts:47

start

start(stateName: string): void
Start the animation state machine
Parameters
- stateName: string
Returns void
- Defined in packages/clik-engine/src/entity/components/AnimatorComponent.ts:42

update

update(delta: number): void
Called every frame
Parameters
- delta: number
Returns void
Inherited from Component.update
- Defined in packages/clik-engine/src/entity/Component.ts:11

Class AnimatorComponent

Hierarchy (View Summary)

Index

Constructors

Properties

Methods

Constructors

constructor

Parameters

Returns AnimatorComponent

Properties

enabled

entity

Methods

addState

Parameters

Returns this

addTransition

Parameters

Returns this

canCancel

Returns boolean

canTransitionTo

Parameters

Returns boolean

forceState

Parameters

Returns void

getCurrent

Returns string | null

getCurrentFrame

Returns number

getSprite

Returns Phaser.GameObjects.Sprite

getStateMachine

Returns AnimationStateMachine

onAttach

Returns void

onDetach

Returns void

reset

Returns void

setState

Parameters

Returns boolean

start

Parameters

Returns void

update

Parameters

Returns void

Settings

On This Page