Class CancelWindow

Index

Constructors

Methods

canCancel clear define getValidTargets getWindows isInCancelWindow

Constructors

constructor

new CancelWindow(): CancelWindow
Returns CancelWindow

Methods

canCancel

canCancel(fromState: string, toState: string, currentFrame: number): boolean
Check if a cancel from fromState into toState is allowed at currentFrame
Parameters
- fromState: string
- toState: string
- currentFrame: number
Returns boolean
- Defined in packages/clik-engine/src/animation/CancelWindow.ts:37

clear

clear(): void
Clear all windows

Returns void
- Defined in packages/clik-engine/src/animation/CancelWindow.ts:76

define

define(state: string, window: CancelWindowDef): this
Define a cancel window for a state
Parameters
- state: string
- window: CancelWindowDef
Returns this
- Defined in packages/clik-engine/src/animation/CancelWindow.ts:28

getValidTargets

getValidTargets(state: string, currentFrame: number): string[]
Get all valid cancel targets for a state at a given frame
Parameters
- state: string
- currentFrame: number
Returns string[]
- Defined in packages/clik-engine/src/animation/CancelWindow.ts:50

getWindows

getWindows(state: string): readonly CancelWindowDef[]
Get all cancel window definitions for a state
Parameters
- state: string
Returns readonly CancelWindowDef[]
- Defined in packages/clik-engine/src/animation/CancelWindow.ts:64

isInCancelWindow

isInCancelWindow(state: string, currentFrame: number): boolean
Check if any cancel window is active for a state at a frame
Parameters
- state: string
- currentFrame: number
Returns boolean
- Defined in packages/clik-engine/src/animation/CancelWindow.ts:69