Interface AnimTimelineStatus

An object containing details about an timeline's current status. Returned by AnimTimeline.getStatus.

interface AnimTimelineStatus {
    atBeginning: boolean;
    atEnd: boolean;
    currentDirection: "forward" | "backward";
    isAnimating: boolean;
    isJumping: boolean;
    isPaused: boolean;
    skippingOn: boolean;
    stepNumber: number;
}

Properties

atBeginning: boolean

true only if the timeline is at the very beginning (i.e., stepNumber is 1).

atEnd: boolean

true only if the timeline is at the very end (i.e., the last sequence has been played).

currentDirection: "forward" | "backward"

The direction the timeline stepped in last (or 'forward' if the timeline has not stepped yet).

isAnimating: boolean

true only if the timeline is in the process of playback (whether paused or unpaused).

isJumping: boolean

true only if the timeline is currently jumping to a point (e.g., using jumpToSequenceTag()).

isPaused: boolean

true only if the timeline is paused.

skippingOn: boolean

true only if skipping is currently on (for example, after using turnSkippingOn()).

stepNumber: number

The current sequential step number, starting from 1 at the start of an unplayed timeline.