Interface

StateComp

:

The state component.

group Component Types

state

: T

Current state.

enterState

: (state: T, args: any) => void

Enter a state, trigger onStateEnd for previous state and onStateEnter for the new State state.

onStateTransition

(from: T, to: T, action: () => void): KEventController

Register event that runs once when a specific state transition happens. Accepts arguments passed from enterState(name, ...args).

since v2000.2

onStateEnter

: (state: T, action: (args: any) => void) => KEventController

Register event that runs once when enters a specific state. Accepts arguments passed from enterState(name, ...args).

onStateEnd

: (state: T, action: () => void) => KEventController

Register an event that runs once when leaves a specific state.

onStateUpdate

: (state: T, action: () => void) => KEventController

Register an event that runs every frame when in a specific state.

onStateDraw

: (state: T, action: () => void) => KEventController

Register an event that runs every frame when in a specific state.

kaplay logo

Layer

Miscalenous