Contains details about an sequence's current status. Returned by AnimSequence.getStatus.

interface AnimSequenceStatus {
    inProgress: boolean;
    isFinished: boolean;
    isPaused: boolean;
    isRunning: boolean;
    lockedStructure: boolean;
    skippingOn: boolean;
    usingFinish: boolean;
    wasPlayed: boolean;
    wasRewound: boolean;
}

Properties

inProgress: boolean

true only if the sequence is in the process of playback (whether running or paused).

isFinished: boolean

true only if the sequence has been played or rewound at least once and is not currently in progress.

isPaused: boolean

true only if the sequence is in the process of playback and paused.

isRunning: boolean

true only if the sequence is in the process of playback and unpaused.

lockedStructure: boolean

Shows whether the sequence is currently allowed to accept changes to its structure. true only if the sequence is in progress or in a forward finished state.

  • Operations like addClips(), removeClips(), etc. check whether the structure is locked before proceeding.
  • Any time the sequence goes back to its starting point after fully rewinding, its structure is unlocked and allowed to accept changes (i.e., lockedStructure is false).
skippingOn: boolean

true only if a parent timeline has skipping enabled (isSkipping is true) or is using a jumping method (isJumping is true).

  • AnimTimelineStatus.isSkipping
  • AnimTimelineStatus.isJumping
usingFinish: boolean

true only if the sequence is currently using finish().

wasPlayed: boolean

true only if the sequence has finished being played and not finished being rewound. (if rewound at all).

  • Resets to false once the sequence has finished being rewound.
wasRewound: boolean

true only if the sequence has finished being rewound and not finished being played.

  • Resets to false once the sequence has finished being rewound. (if played at all).