Options
All
  • Public
  • Public/Protected
  • All
Menu

Interface Tween

The interface which all of the tweens implement

Hierarchy

  • Tween

Implemented by

Index

Properties

Methods

Properties

isFinished

isFinished: boolean

Whether the tween has finished

Methods

advance

  • advance(durationToAdvance: number): number
  • Advances the tween by the given amount of unitless duration.

    Parameters

    • durationToAdvance: number

    Returns number

    The amount of duration consumed by this tween which will always be between 0 (no duration consumed) and durationToAdvance (consumed all the duration)

finish

  • finish(): void
  • Stops the execution of the tween early triggering all possible effects along the way. Please note it's not the same as calling advance() with some large number, because a tween may have external conditions that do not depend on the duration, eg. waiting for a user interaction or external event. finish() will just finish those tweens as if the conditions were met.

    Returns void

skip

  • skip(): void
  • Stops the execution of the tween early and prevents any possible effect that would have happened if finish() was called.

    Returns void

Generated using TypeDoc