ClassTweens & Motion@public

FlxTween

Base deterministic tween. Use the static factories for common tweens.

export declare class FlxTween

Constructors

constructor(options?: FlxTweenOptions, manager?: FlxTweenManager)

Constructs a new instance of the FlxTween class

Parameter	Type	Description
options	FlxTweenOptions	-
manager	FlxTweenManager	-

Properties

Property	Modifiers	Type	Description
active	-	boolean	-
backward	-	boolean	-
BACKWARD	static readonly	FlxTweenType	-
duration	-	number	-
ease	-	FlxEaseFunction | null	-
executions	-	number	-
finished	-	boolean	-
framerate	-	number	-
globalManager	static readonly	FlxTweenManager	-
loopDelay	-	number	-
LOOPING	static readonly	FlxTweenType	-
manager	readonly	FlxTweenManager	-
onComplete	-	FlxTweenCallback | null	-
ONESHOT	static readonly	FlxTweenType	-
onStart	-	FlxTweenCallback | null	-
onUpdate	-	FlxTweenCallback | null	-
percent	-	number	-
PERSIST	static readonly	FlxTweenType	-
PINGPONG	static readonly	FlxTweenType	-
scale	-	number	-
startDelay	-	number	-
time	readonly	number	-
type	-	FlxTweenType	-

Methods

static angle()

static angle(sprite: FlxObject | null, fromAngle: number, toAngle: number, duration?: number, options?: FlxTweenOptions): FlxAngleTween

Parameters:

Parameter	Type	Description
sprite	FlxObject | null	-
fromAngle	number	-
toAngle	number	-
duration	number	-
options	FlxTweenOptions	-

Returns: FlxAngleTween

cancel()

cancel(): void

Returns: void

cancelChain()

cancelChain(): void

Returns: void

static cancelTweensOf()

static cancelTweensOf(target: object, fieldPaths?: readonly string[]): void

Parameters:

Parameter	Type	Description
target	object	-
fieldPaths	readonly string[]	-

Returns: void

static circularMotion()

static circularMotion(object: FlxObject, centerX: number, centerY: number, radius: number, angle: number, clockwise: boolean, durationOrSpeed?: number, useDuration?: boolean, options?: FlxTweenOptions): FlxCircularMotion

Parameters:

Parameter	Type	Description
object	FlxObject	-
centerX	number	-
centerY	number	-
radius	number	-
angle	number	-
clockwise	boolean	-
durationOrSpeed	number	-
useDuration	boolean	-
options	FlxTweenOptions	-

Returns: FlxCircularMotion

static color()

static color(sprite: FlxColorTweenTarget | null, duration: number, fromColor: FlxTweenColorValue, toColor: FlxTweenColorValue, options?: FlxTweenOptions): FlxColorTween

Parameters:

Parameter	Type	Description
sprite	FlxColorTweenTarget | null	-
duration	number	-
fromColor	FlxTweenColorValue	-
toColor	FlxTweenColorValue	-
options	FlxTweenOptions	-

Returns: FlxColorTween

static completeTweensOf()

static completeTweensOf(target: object, fieldPaths?: readonly string[]): void

Parameters:

Parameter	Type	Description
target	object	-
fieldPaths	readonly string[]	-

Returns: void

static cubicMotion()

static cubicMotion(object: FlxObject, fromX: number, fromY: number, controlAX: number, controlAY: number, controlBX: number, controlBY: number, toX: number, toY: number, duration?: number, options?: FlxTweenOptions): FlxCubicMotion

Parameters:

Parameter	Type	Description
object	FlxObject	-
fromX	number	-
fromY	number	-
controlAX	number	-
controlAY	number	-
controlBX	number	-
controlBY	number	-
toX	number	-
toY	number	-
duration	number	-
options	FlxTweenOptions	-

Returns: FlxCubicMotion

destroy()

destroy(): void

Returns: void

static flicker()

static flicker(basic: FlxBasic, duration?: number, period?: number, options?: FlxFlickerTweenOptions): FlxFlickerTween

Parameters:

Parameter	Type	Description
basic	FlxBasic	-
duration	number	-
period	number	-
options	FlxFlickerTweenOptions	-

Returns: FlxFlickerTween

static isFlickering()

static isFlickering(basic: FlxBasic): boolean

Parameters:

Parameter	Type	Description
basic	FlxBasic	-

Returns: boolean

static linearMotion()

static linearMotion(object: FlxObject, fromX: number, fromY: number, toX: number, toY: number, durationOrSpeed?: number, useDuration?: boolean, options?: FlxTweenOptions): FlxLinearMotion

Parameters:

Parameter	Type	Description
object	FlxObject	-
fromX	number	-
fromY	number	-
toX	number	-
toY	number	-
durationOrSpeed	number	-
useDuration	boolean	-
options	FlxTweenOptions	-

Returns: FlxLinearMotion

static linearPath()

static linearPath(object: FlxObject, points: readonly PointLike[], durationOrSpeed?: number, useDuration?: boolean, options?: FlxTweenOptions): FlxLinearPath

Parameters:

Parameter	Type	Description
object	FlxObject	-
points	readonly PointLike[]	-
durationOrSpeed	number	-
useDuration	boolean	-
options	FlxTweenOptions	-

Returns: FlxLinearPath

static num()

static num(fromValue: number, toValue: number, duration?: number, options?: FlxTweenOptions, tweenFunction?: (value: number) => void): FlxNumTween

Parameters:

Parameter	Type	Description
fromValue	number	-
toValue	number	-
duration	number	-
options	FlxTweenOptions	-
tweenFunction	(value: number) => void	-

Returns: FlxNumTween

static quadMotion()

static quadMotion(object: FlxObject, fromX: number, fromY: number, controlX: number, controlY: number, toX: number, toY: number, durationOrSpeed?: number, useDuration?: boolean, options?: FlxTweenOptions): FlxQuadMotion

Parameters:

Parameter	Type	Description
object	FlxObject	-
fromX	number	-
fromY	number	-
controlX	number	-
controlY	number	-
toX	number	-
toY	number	-
durationOrSpeed	number	-
useDuration	boolean	-
options	FlxTweenOptions	-

Returns: FlxQuadMotion

static quadPath()

static quadPath(object: FlxObject, points: readonly PointLike[], durationOrSpeed?: number, useDuration?: boolean, options?: FlxTweenOptions): FlxQuadPath

Parameters:

Parameter	Type	Description
object	FlxObject	-
points	readonly PointLike[]	-
durationOrSpeed	number	-
useDuration	boolean	-
options	FlxTweenOptions	-

Returns: FlxQuadPath

static shake()

static shake(sprite: FlxSprite, intensity?: number, duration?: number, axes?: FlxTweenAxes, options?: FlxTweenOptions): FlxShakeTween

Parameters:

Parameter	Type	Description
sprite	FlxSprite	-
intensity	number	-
duration	number	-
axes	FlxTweenAxes	-
options	FlxTweenOptions	-

Returns: FlxShakeTween

start()

start(): this

Returns: this

then()

then(tween: FlxTween): this

Parameters:

Parameter	Type	Description
tween	FlxTween	-

Returns: this

static tween()

static tween<T extends object>(target: T, values: Record<string, number>, duration?: number, options?: FlxTweenOptions): FlxVarTween<T>

Parameters:

Parameter	Type	Description
target	T	-
values	Record<string, number>	-
duration	number	-
options	FlxTweenOptions	-

Returns: FlxVarTween<T>

wait()

wait(delay: number): this

Parameters:

Parameter	Type	Description
delay	number	-

Returns: this