ClassAnimation & Atlases@public

FlxAnimationController

HaxeFlixel-style animation API backed by a deterministic FlxSprite clock.

export declare class FlxAnimationController

Constructors

constructor(sprite: FlxSprite)

Constructs a new instance of the FlxAnimationController class

Parameter	Type	Description
sprite	FlxSprite	-

Properties

Property	Modifiers	Type	Description
curAnim	-	FlxAnim | null	-
finished	-	boolean	-
frameIndex	-	number	-
frameName	-	string | null	-
name	-	string | null	-
numFrames	readonly	number	-
onFinish	readonly	FlxSignal<string>	-
onFrameChange	readonly	FlxSignal<FlxAnimationFrameEvent>	-
onLoop	readonly	FlxSignal<string>	-
paused	-	boolean	-
timeScale	-	number	-

Methods

add()

add(name: string, frames: readonly number[], frameRate?: number, looped?: boolean, flipX?: boolean, flipY?: boolean): void

Parameters:

Parameter	Type	Description
name	string	-
frames	readonly number[]	-
frameRate	number	-
looped	boolean	-
flipX	boolean	-
flipY	boolean	-

Returns: void

addByIndices()

addByIndices(name: string, prefix: string, indices: readonly number[], postfix?: string, frameRate?: number, looped?: boolean, flipX?: boolean, flipY?: boolean): void

Parameters:

Parameter	Type	Description
name	string	-
prefix	string	-
indices	readonly number[]	-
postfix	string	-
frameRate	number	-
looped	boolean	-
flipX	boolean	-
flipY	boolean	-

Returns: void

addByNames()

addByNames(name: string, frameNames: readonly string[], frameRate?: number, looped?: boolean, flipX?: boolean, flipY?: boolean): void

Parameters:

Parameter	Type	Description
name	string	-
frameNames	readonly string[]	-
frameRate	number	-
looped	boolean	-
flipX	boolean	-
flipY	boolean	-

Returns: void

addByPrefix()

addByPrefix(name: string, prefix: string, frameRate?: number, looped?: boolean, flipX?: boolean, flipY?: boolean): void

Parameters:

Parameter	Type	Description
name	string	-
prefix	string	-
frameRate	number	-
looped	boolean	-
flipX	boolean	-
flipY	boolean	-

Returns: void

append()

append(name: string, frames: readonly number[]): void

Parameters:

Parameter	Type	Description
name	string	-
frames	readonly number[]	-

Returns: void

destroy()

destroy(): void

Returns: void

exists()

exists(name: string): boolean

Parameters:

Parameter	Type	Description
name	string	-

Returns: boolean

finish()

finish(): void

Returns: void

getAnimationList()

getAnimationList(): FlxAnim[]

Returns: FlxAnim[]

getNameList()

getNameList(): string[]

Returns: string[]

play()

play(name: string, force?: boolean, reversed?: boolean, frame?: number): void

Parameters:

Parameter	Type	Description
name	string	-
force	boolean	-
reversed	boolean	-
frame	number	-

Returns: void

randomFrame()

randomFrame(): void

Returns: void

remove()

remove(name: string): boolean

Parameters:

Parameter	Type	Description
name	string	-

Returns: boolean

rename()

rename(oldName: string, newName: string): boolean

Parameters:

Parameter	Type	Description
oldName	string	-
newName	string	-

Returns: boolean

stop()

stop(): void

Returns: void