Skip to content
ClassAnimation & Atlases@public

FlxAnim

Named frame sequence used by FlxSprite.

ts
export declare class FlxAnim

Constructors

ts
constructor(name: string, frames: readonly number[], frameRate?: number, looped?: boolean, defaultSpeed?: number, flipX?: boolean, flipY?: boolean)

Constructs a new instance of the FlxAnim class

ParameterTypeDescription
namestring-
framesreadonly number[]-
frameRatenumber-
loopedboolean-
defaultSpeednumber-
flipXboolean-
flipYboolean-

Properties

PropertyModifiersTypeDescription
curFrame-number-
defaultLoopedreadonlybooleanDefault loop flag recorded at addAnimation time. Used by play(name) (no options) to restore the legacy 4-arg behaviour.
defaultSpeedreadonlynumberDefault playback speed multiplier recorded at addAnimation time. 1 = one animation frame per game update; stored for option-less play.
delayreadonlynumber-
finished-boolean-
flipX-boolean-
flipY-boolean-
frameDuration-number-
frameRate-number-
frames-number[]-
looped-boolean-
loopPoint-number-
name-string-
numFramesreadonlynumber-
paused-boolean-
reversed-boolean-
timeScale-number-

Methods

destroy()

ts
destroy(): void

Returns: void

Released under the MIT License.