Class AnimSequence

parentTimeline

• get parentTimeline(): undefined | AnimTimeline

• The parent AnimTimeline that contains this sequence (undefined if the sequence is not part of a timeline).

  Returns undefined | AnimTimeline

root

• get root(): AnimSequence | AnimTimeline

• The highest level of this sequence's lineage.

  • If the sequence is nested within an AnimTimeline: that timeline,
  • Else: the sequence itself

  Returns AnimSequence | AnimTimeline

addClips

• addClips(...animClips): this

• Adds one or more AnimClip objects to the end of the sequence.

  Parameters

  • Rest...animClips: AnimClip<Readonly<StripDuplicateMethodAutocompletion<{
        defaultConfig?: Partial<unknown>;
        effectCompositionFrequency?: "on-first-play-only" | "on-every-play";
        immutableConfig?: Partial<unknown>;
        composeEffect(...effectOptions: unknown[]): StripDuplicateMethodAutocompletion<{
            backwardKeyframesGenerator?: (() => Keyframes);
            backwardMutatorGenerator?: (() => Mutator);
            forwardKeyframesGenerator?: (() => Keyframes);
            forwardMutatorGenerator?: (() => Mutator);
            reverseKeyframesEffect?: boolean;
            reverseMutatorEffect?: boolean;
        }>;
    }>>, AnimClipConfig>[]

    comma-separated list of animation clips

  Returns this

addClipsAt

• addClipsAt(index, ...animClips): this

• Adds one or more AnimClip objects to the specified index of the sequence.

  Parameters

  • index: number

    the index at which the clips should be inserted
  • Rest...animClips: AnimClip<Readonly<StripDuplicateMethodAutocompletion<{
        defaultConfig?: Partial<unknown>;
        effectCompositionFrequency?: "on-first-play-only" | "on-every-play";
        immutableConfig?: Partial<unknown>;
        composeEffect(...effectOptions: unknown[]): StripDuplicateMethodAutocompletion<{
            backwardKeyframesGenerator?: (() => Keyframes);
            backwardMutatorGenerator?: (() => Mutator);
            forwardKeyframesGenerator?: (() => Keyframes);
            forwardMutatorGenerator?: (() => Mutator);
            reverseKeyframesEffect?: boolean;
            reverseMutatorEffect?: boolean;
        }>;
    }>>, AnimClipConfig>[]

    comma-separated list of animation clips

  Returns this

findClipIndex

• findClipIndex(animClip): number

• Finds the index of a given AnimClip object within the sequence

  Parameters

  • animClip: AnimClip<Readonly<StripDuplicateMethodAutocompletion<{
        defaultConfig?: Partial<unknown>;
        effectCompositionFrequency?: "on-first-play-only" | "on-every-play";
        immutableConfig?: Partial<unknown>;
        composeEffect(...effectOptions: unknown[]): StripDuplicateMethodAutocompletion<{
            backwardKeyframesGenerator?: (() => Keyframes);
            backwardMutatorGenerator?: (() => Mutator);
            forwardKeyframesGenerator?: (() => Keyframes);
            forwardMutatorGenerator?: (() => Mutator);
            reverseKeyframesEffect?: boolean;
            reverseMutatorEffect?: boolean;
        }>;
    }>>, AnimClipConfig>

    the animation clip to search for within the sequence

  Returns number

  The index of animClip within the sequence or -1 if the clip is not part of the sequence.

removeClips

• removeClips(...animClips): this

• Removes one or more AnimClip objects from the sequence.

  Parameters

  • Rest...animClips: AnimClip<Readonly<StripDuplicateMethodAutocompletion<{
        defaultConfig?: Partial<unknown>;
        effectCompositionFrequency?: "on-first-play-only" | "on-every-play";
        immutableConfig?: Partial<unknown>;
        composeEffect(...effectOptions: unknown[]): StripDuplicateMethodAutocompletion<{
            backwardKeyframesGenerator?: (() => Keyframes);
            backwardMutatorGenerator?: (() => Mutator);
            forwardKeyframesGenerator?: (() => Keyframes);
            forwardMutatorGenerator?: (() => Mutator);
            reverseKeyframesEffect?: boolean;
            reverseMutatorEffect?: boolean;
        }>;
    }>>, AnimClipConfig>[]

    comma-separated list of animation clips

  Returns this

removeClipsAt

• removeClipsAt(startIndex, endIndex?): AnimClip<Readonly<StripDuplicateMethodAutocompletion<{
      defaultConfig?: Partial<unknown>;
      effectCompositionFrequency?: "on-first-play-only" | "on-every-play";
      immutableConfig?: Partial<unknown>;
      composeEffect(...effectOptions: unknown[]): StripDuplicateMethodAutocompletion<{
          backwardKeyframesGenerator?: (() => Keyframes);
          backwardMutatorGenerator?: (() => Mutator);
          forwardKeyframesGenerator?: (() => Keyframes);
          forwardMutatorGenerator?: (() => Mutator);
          reverseKeyframesEffect?: boolean;
          reverseMutatorEffect?: boolean;
      }>;
  }>>, AnimClipConfig>[]

• Removes a number of AnimClip objects from the sequence based on the provided indices range (0-based).

  Parameters

  • startIndex: number

    the starting index, inclusive
  • endIndex: number = ...

    the ending index, exclusive

  Returns AnimClip<Readonly<StripDuplicateMethodAutocompletion<{
      defaultConfig?: Partial<unknown>;
      effectCompositionFrequency?: "on-first-play-only" | "on-every-play";
      immutableConfig?: Partial<unknown>;
      composeEffect(...effectOptions: unknown[]): StripDuplicateMethodAutocompletion<{
          backwardKeyframesGenerator?: (() => Keyframes);
          backwardMutatorGenerator?: (() => Mutator);
          forwardKeyframesGenerator?: (() => Keyframes);
          forwardMutatorGenerator?: (() => Mutator);
          reverseKeyframesEffect?: boolean;
          reverseMutatorEffect?: boolean;
      }>;
  }>>, AnimClipConfig>[]

  An array containing the clips that were removed from the sequence.

Readonlyid

getConfig

• getConfig(): AnimSequenceConfig

• Returns an object containing the configuration options used to define the timing, jump tag, and description of the animation sequence.

  Returns AnimSequenceConfig

  An object containing

  • autoplays,
  • autoplaysNextSequence,
  • description,
  • playbackRate,
  • jumpTag,

getDescription

• getDescription(): string

• Returns string

  The description for this sequence.

  See

  AnimSequenceConfig.description

getJumpTag

• getJumpTag(): string

• Returns string

  The jumpTag for this sequence.

  See

  jumpTag

getStatus

• getStatus(): AnimSequenceStatus

• Returns details about an sequence's current status.

  Returns AnimSequenceStatus

  An object containing

  • inProgress,
  • isPaused,
  • isRunning,
  • skippingOn,
  • isFinished,
  • usingFinish,
  • wasPlayed,
  • wasRewound,
  • lockedStructure,

getTiming

• getTiming(): AnimSequenceTiming

• Returns timing-related details about the sequence.

  Returns AnimSequenceTiming

  An object containing

  • autoplays,
  • autoplaysNextSequence,
  • compoundedPlaybackRate,
  • playbackRate,

setDescription

• setDescription(description): this

• Sets the description for this sequence.

  Parameters

  • description: string

    new description

  Returns this

  See

  AnimSequenceConfig.description

setJumpTag

• setJumpTag(jumpTag): this

• Sets the jumpTag for this sequence.

  Parameters

  • jumpTag: string

    new jump tag

  Returns this

  See

  AnimSequenceConfig.jumpTag

finish

• finish(): Promise<AnimSequence>

• Forces the animation sequence to instantly finish.

  • This works even if the animation sequence is not already currently in progress.
  • The sequence will still pause for any roadblocks generated by AnimClip.addRoadblocks.
  • Does not work if the sequence is currently paused.

  Returns Promise<AnimSequence>

finishInProgressAnimations

• finishInProgressAnimations(): Promise<AnimSequence>

• Forces the animation clips that are currently running within the sequence to instantly finish.

  • After the currently running animation clips complete, the rest of the sequence runs normally.
  • The sequence will still pause for any roadblocks generated by AnimClip.addRoadblocks.

  Returns Promise<AnimSequence>

pause

• pause(): this

• Pauses the animation sequence.

  • If the sequence is not already in progress, this method does nothing.

  Returns this

play

• play(): Promise<AnimSequence>

• Plays the animation sequence (sequence runs forward).

  Returns Promise<AnimSequence>

  A promise that is resolved when the sequence finishes playing.

rewind

• rewind(): Promise<AnimSequence>

• Rewinds the animation sequence (sequence runs backward).

  Returns Promise<AnimSequence>

  A promise that is resolved when the sequence finishes rewinding.

unpause

• unpause(): this

• Unpauses the animation sequence.

  • If the sequence is not currently paused, this method does nothing.

  Returns this

updatePlaybackRate

• updatePlaybackRate(newRate): this

• Sets the base playback rate of the sequence.

  Parameters

  • newRate: number

    the new playback rate

  Returns this

setOnFinish

• setOnFinish(functions): this

• Parameters

  • functions: {
        do: Function;
        undo: Function;
    }

    • do: Function

    • undo: Function

  Returns this

setOnStart

• setOnStart(functions): this

• Parameters

  • functions: {
        do: Function;
        undo: Function;
    }

    • do: Function

    • undo: Function

  Returns this

getConfig

• getConfig(): AnimSequenceConfig

• Returns an object containing the configuration options used to define the timing, jump tag, and description of the animation sequence.

  Returns AnimSequenceConfig

  An object containing

  • autoplays,
  • autoplaysNextSequence,
  • description,
  • playbackRate,
  • jumpTag,