❮ Previous Next ❯

Tween Pause

  • Pauses the animation instance — optionally moving the playhead to a specific time before pausing.

  • pause()

    pause(atTime:Number, suppressEvents:Boolean): self

    Pauses the animation instance — optionally moving the playhead to a specific time before pausing.

    Parameters

    • atTime (Number, default = null)

      • The time (in seconds) where the animation should jump before pausing.

      • If omitted, the animation pauses at its current playhead position.

      • For timelines, this can also be a label name instead of a number.

    • suppressEvents (Boolean, default = true)

      • When true (default), no callbacks or events are triggered while jumping to the new position.

      • Set to false if you want all skipped events/callbacks to fire during the time jump.

    Returns

    • self – Returns the animation instance to allow method chaining.

    Details

    pause() halts the animation at its current playhead position — or, if a time is specified, jumps to that position first and then pauses.

    When jumping to a new time, the animation skips over all intermediate callbacks or events by default because suppressEvents is set to true.
    This behavior is similar to lifting the needle on a record player and placing it on a new section — no sound plays while it moves.

    If you want the events or callbacks in between to still execute, set suppressEvents to false.

// Pause wherever the playhead currently is:
myAnimation.pause();

// Jump to exactly 2 seconds into the animation, then pause:
myAnimation.pause(2);

// Jump to 2 seconds into the animation and pause,
// but allow events/callbacks during the move:
myAnimation.pause(2, false);
❮ Previous Next ❯