Class Tween<T>

constructor

• new Tween<T extends UnknownProps = any>(object: T, group?: default): Tween<T>

  Type Parameters

  • T extends UnknownProps = any

  Parameters

  • object: T

    The object whose properties this Tween will animate.
  • Optionalgroup: default

    The object whose properties this Tween will animate.

  Returns Tween<T>
• new Tween<T extends UnknownProps = any>(object: T, group: true): Tween<T>
  Deprecated

  The group parameter is now deprecated, instead use new Tween(object) then group.add(tween) to add a tween to a group. Use new Tween(object, true) to restore the old behavior for now, but this will be removed in the future.

  Type Parameters

  • T extends UnknownProps = any

  Parameters

  • object: T
  • group: true

  Returns Tween<T>

StaticautoStartOnUpdate

chain

• chain(...tweens: Tween<any>[]): this

  Parameters

  • ...tweens: Tween<any>[]

  Returns this

delay

• delay(amount?: number): this

  Parameters

  • amount: number = 0

  Returns this

duration

• duration(duration?: number): this

  Parameters

  • duration: number = 1000

  Returns this

dynamic

• dynamic(dynamic?: boolean): this

  Parameters

  • dynamic: boolean = false

  Returns this

easing

• easing(easingFunction?: EasingFunction): this

  Parameters

  • easingFunction: EasingFunction = Easing.Linear.None

  Returns this

end

• end(): this

  Returns this

getDuration

• getDuration(): number

  Returns number

getId

• getId(): number

  Returns number

group

• group(group: default): this

  Removes the tween from the current group it is in, if any, then adds the tween to the specified group.

  Parameters

  • group: default

  Returns this
• group(): this
  Deprecated

  The argless call signature has been removed. Use tween.group(group) or group.add(tween), instead.

  Returns this

interpolation

• interpolation(interpolationFunction?: InterpolationFunction): this

  Parameters

  • interpolationFunction: InterpolationFunction = Interpolation.Linear

  Returns this

isPaused

• isPaused(): boolean

  Returns boolean

isPlaying

• isPlaying(): boolean

  Returns boolean

onComplete

• onComplete(callback?: (object: T) => void): this

  Parameters

  • Optionalcallback: (object: T) => void

  Returns this

onEveryStart

• onEveryStart(callback?: (object: T) => void): this

  Parameters

  • Optionalcallback: (object: T) => void

  Returns this

onRepeat

• onRepeat(callback?: (object: T) => void): this

  Parameters

  • Optionalcallback: (object: T) => void

  Returns this

onStart

• onStart(callback?: (object: T) => void): this

  Parameters

  • Optionalcallback: (object: T) => void

  Returns this

onStop

• onStop(callback?: (object: T) => void): this

  Parameters

  • Optionalcallback: (object: T) => void

  Returns this

onUpdate

• onUpdate(callback?: (object: T, elapsed: number) => void): this

  Parameters

  • Optionalcallback: (object: T, elapsed: number) => void

  Returns this

pause

• pause(time?: number): this

  Parameters

  • time: number = ...

  Returns this

remove

• remove(): Tween<T>

  Removes the tween from whichever group it is in.

  Returns Tween<T>

repeat

• repeat(times?: number): this

  Parameters

  • times: number = 0

  Returns this

repeatDelay

• repeatDelay(amount?: number): this

  Parameters

  • Optionalamount: number

  Returns this

resume

• resume(time?: number): this

  Parameters

  • time: number = ...

  Returns this

start

• start(time?: number, overrideStartingValues?: boolean): this

  Parameters

  • time: number = ...
  • overrideStartingValues: boolean = false

  Returns this

startFromCurrentValues

• startFromCurrentValues(time?: number): this

  Parameters

  • Optionaltime: number

  Returns this

stop

• stop(): this

  Returns this

stopChainedTweens

• stopChainedTweens(): this

  Returns this

to

• to(target: UnknownProps, duration?: number): this

  Parameters

  • target: UnknownProps
  • duration: number = 1000

  Returns this

update

• update(time?: number, autoStart?: boolean): boolean

  Parameters

  • time: number = ...
  • autoStart: boolean = Tween.autoStartOnUpdate

    When true, calling update will implicitly call start() as well. Note, if you stop() or end() the tween, but are still calling update(), it will start again!

  Returns boolean

  true if the tween is still playing after the update, false otherwise (calling update on a paused tween still returns true because it is still playing, just paused).

yoyo

• yoyo(yoyo?: boolean): this

  Parameters

  • yoyo: boolean = false

  Returns this