Skip to content
InterfaceAnimation & Atlases@public

FlxAnimationPlayOptions

Options for FlxSprite.play when using the object-form overload.

ts
export interface FlxAnimationPlayOptions

Properties

PropertyModifiersTypeDescription
force-booleanForce restart even if this animation is already playing. Default false.
frame-numberStarting frame number within the animation. Default 0.
loop-booleanWhether the animation loops. Default false for the options-object form. Use the legacy addAnimation(name, frames, frameRate, looped) call if you want looping to be the stored default.
reversed-booleanPlay frames in reverse order. Default false.
speed-numberPlayback speed multiplier relative to the game update rate. 1 = one animation frame per update. Must be positive. Default 1.

Released under the MIT License.