ClassTween<T>

constructor

• new Tween<T>(object, group?): 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>(object, group): 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): this

• Parameters

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

  Returns this

delay

• delay(amount?): this

• Parameters

  • amount: number = 0

  Returns this

duration

• duration(duration?): this

• Parameters

  • duration: number = 1000

  Returns this

dynamic

• dynamic(dynamic?): this

• Parameters

  • dynamic: boolean = false

  Returns this

easing

• easing(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): 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?): this

• Parameters

  • interpolationFunction: InterpolationFunction = Interpolation.Linear

  Returns this

isPaused

• isPaused(): boolean

• Returns boolean

isPlaying

• isPlaying(): boolean

• Returns boolean

onComplete

• onComplete(callback?): this

• Parameters

  • Optionalcallback: ((object: T) => void)
    • • (object): void

      • Parameters

        • object: T

        Returns void

  Returns this

onEveryStart

• onEveryStart(callback?): this

• Parameters

  • Optionalcallback: ((object: T) => void)
    • • (object): void

      • Parameters

        • object: T

        Returns void

  Returns this

onRepeat

• onRepeat(callback?): this

• Parameters

  • Optionalcallback: ((object: T) => void)
    • • (object): void

      • Parameters

        • object: T

        Returns void

  Returns this

onStart

• onStart(callback?): this

• Parameters

  • Optionalcallback: ((object: T) => void)
    • • (object): void

      • Parameters

        • object: T

        Returns void

  Returns this

onStop

• onStop(callback?): this

• Parameters

  • Optionalcallback: ((object: T) => void)
    • • (object): void

      • Parameters

        • object: T

        Returns void

  Returns this

onUpdate

• onUpdate(callback?): this

• Parameters

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

      • Parameters

        • object: T
        • elapsed: number

        Returns void

  Returns this

pause

• pause(time?): 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?): this

• Parameters

  • times: number = 0

  Returns this

repeatDelay

• repeatDelay(amount?): this

• Parameters

  • Optionalamount: number

  Returns this

resume

• resume(time?): this

• Parameters

  • time: number = ...

  Returns this

start

• start(time?, overrideStartingValues?): this

• Parameters

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

  Returns this

startFromCurrentValues

• startFromCurrentValues(time?): this

• Parameters

  • Optionaltime: number

  Returns this

stop

• stop(): this

• Returns this

stopChainedTweens

• stopChainedTweens(): this

• Returns this

to

• to(target, duration?): this

• Parameters

  • target: UnknownProps
  • duration: number = 1000

  Returns this

update

• update(time?, autoStart?): 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?): this

• Parameters

  • yoyo: boolean = false

  Returns this