Class AnimSequence

parentTimeline

• get parentTimeline(): AnimTimeline | undefined

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

  Returns AnimTimeline | undefined

root

• get root(): AnimSequence | AnimTimeline

  The highest level of this sequence's lineage.

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

  Returns AnimSequence | AnimTimeline

addClips

• addClips(
      animClips: AnimClip<
          Readonly<
              StripDuplicateMethodAutocompletion<
                  {
                      defaultConfig?: Partial<unknown> & object;
                      howOftenBuildGenerators?: "on-first-play-only" | "on-every-play";
                      immutableConfig?: Partial<unknown> & object;
                      buildFrameGenerators(
                          this: Readonly<
                              Pick<
                                  (
                                      AnimClip<Readonly<StripDuplicateMethodAutocompletion<{ defaultConfig?: (Partial<unknown> & object) | undefined; immutableConfig?: (Partial<unknown> & object) | undefined; howOftenBuildGenerators?: "on-first-play-only" | "on-every-play" | undefined; buildFrameGenerators(this: Readonly<Pick<AnimClip<Readonly<StripDuplicateMethodAutocompletion<any>>, AnimClipConfig>, "computeTween">>, ...effectOptions: unknown[]): EffectFrameGeneratorSet; }>>, AnimClipConfig>
                                  ),
                                  "computeTween",
                              >,
                          >,
                          ...effectOptions: unknown[],
                      ): EffectFrameGeneratorSet;
                  },
              >,
          >,
          AnimClipConfig,
      >[],
  ): this

  Adds AnimClip objects to the end of the sequence.

  Parameters

  • animClips: AnimClip<
        Readonly<
            StripDuplicateMethodAutocompletion<
                {
                    defaultConfig?: Partial<unknown> & object;
                    howOftenBuildGenerators?: "on-first-play-only" | "on-every-play";
                    immutableConfig?: Partial<unknown> & object;
                    buildFrameGenerators(
                        this: Readonly<
                            Pick<
                                (
                                    AnimClip<Readonly<StripDuplicateMethodAutocompletion<{ defaultConfig?: (Partial<unknown> & object) | undefined; immutableConfig?: (Partial<unknown> & object) | undefined; howOftenBuildGenerators?: "on-first-play-only" | "on-every-play" | undefined; buildFrameGenerators(this: Readonly<Pick<AnimClip<Readonly<StripDuplicateMethodAutocompletion<any>>, AnimClipConfig>, "computeTween">>, ...effectOptions: unknown[]): EffectFrameGeneratorSet; }>>, AnimClipConfig>
                                ),
                                "computeTween",
                            >,
                        >,
                        ...effectOptions: unknown[],
                    ): EffectFrameGeneratorSet;
                },
            >,
        >,
        AnimClipConfig,
    >[]

    An array of animation clips to add.

  Returns this

• addClips(
      location: AddClipsOptions,
      animClips: AnimClip<
          Readonly<
              StripDuplicateMethodAutocompletion<
                  {
                      defaultConfig?: Partial<unknown> & object;
                      howOftenBuildGenerators?: "on-first-play-only" | "on-every-play";
                      immutableConfig?: Partial<unknown> & object;
                      buildFrameGenerators(
                          this: Readonly<
                              Pick<
                                  (
                                      AnimClip<Readonly<StripDuplicateMethodAutocompletion<{ defaultConfig?: (Partial<unknown> & object) | undefined; immutableConfig?: (Partial<unknown> & object) | undefined; howOftenBuildGenerators?: "on-first-play-only" | "on-every-play" | undefined; buildFrameGenerators(this: Readonly<Pick<AnimClip<Readonly<StripDuplicateMethodAutocompletion<any>>, AnimClipConfig>, "computeTween">>, ...effectOptions: unknown[]): EffectFrameGeneratorSet; }>>, AnimClipConfig>
                                  ),
                                  "computeTween",
                              >,
                          >,
                          ...effectOptions: unknown[],
                      ): EffectFrameGeneratorSet;
                  },
              >,
          >,
          AnimClipConfig,
      >[],
  ): this

  Adds AnimClip objects to the specified location within the sequence.

  Parameters

  • location: AddClipsOptions

    An options object specifying the location at which the clips should be inserted.

  • animClips: AnimClip<
        Readonly<
            StripDuplicateMethodAutocompletion<
                {
                    defaultConfig?: Partial<unknown> & object;
                    howOftenBuildGenerators?: "on-first-play-only" | "on-every-play";
                    immutableConfig?: Partial<unknown> & object;
                    buildFrameGenerators(
                        this: Readonly<
                            Pick<
                                (
                                    AnimClip<Readonly<StripDuplicateMethodAutocompletion<{ defaultConfig?: (Partial<unknown> & object) | undefined; immutableConfig?: (Partial<unknown> & object) | undefined; howOftenBuildGenerators?: "on-first-play-only" | "on-every-play" | undefined; buildFrameGenerators(this: Readonly<Pick<AnimClip<Readonly<StripDuplicateMethodAutocompletion<any>>, AnimClipConfig>, "computeTween">>, ...effectOptions: unknown[]): EffectFrameGeneratorSet; }>>, AnimClipConfig>
                                ),
                                "computeTween",
                            >,
                        >,
                        ...effectOptions: unknown[],
                    ): EffectFrameGeneratorSet;
                },
            >,
        >,
        AnimClipConfig,
    >[]

    The array of animation clips to add.

  Returns this

findClipIndex

• findClipIndex(animClip: AnimClip): number

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

  Parameters

  • animClip: AnimClip

    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: AnimClip<
          Readonly<
              StripDuplicateMethodAutocompletion<
                  {
                      defaultConfig?: Partial<unknown> & object;
                      howOftenBuildGenerators?: "on-first-play-only" | "on-every-play";
                      immutableConfig?: Partial<unknown> & object;
                      buildFrameGenerators(
                          this: Readonly<
                              Pick<
                                  (
                                      AnimClip<Readonly<StripDuplicateMethodAutocompletion<{ defaultConfig?: (Partial<unknown> & object) | undefined; immutableConfig?: (Partial<unknown> & object) | undefined; howOftenBuildGenerators?: "on-first-play-only" | "on-every-play" | undefined; buildFrameGenerators(this: Readonly<Pick<AnimClip<Readonly<StripDuplicateMethodAutocompletion<any>>, AnimClipConfig>, "computeTween">>, ...effectOptions: unknown[]): EffectFrameGeneratorSet; }>>, AnimClipConfig>
                                  ),
                                  "computeTween",
                              >,
                          >,
                          ...effectOptions: unknown[],
                      ): EffectFrameGeneratorSet;
                  },
              >,
          >,
          AnimClipConfig,
      >[],
  ): this

  Removes the specified AnimClip objects from the sequence.

  Parameters

  • animClips: AnimClip<
        Readonly<
            StripDuplicateMethodAutocompletion<
                {
                    defaultConfig?: Partial<unknown> & object;
                    howOftenBuildGenerators?: "on-first-play-only" | "on-every-play";
                    immutableConfig?: Partial<unknown> & object;
                    buildFrameGenerators(
                        this: Readonly<
                            Pick<
                                (
                                    AnimClip<Readonly<StripDuplicateMethodAutocompletion<{ defaultConfig?: (Partial<unknown> & object) | undefined; immutableConfig?: (Partial<unknown> & object) | undefined; howOftenBuildGenerators?: "on-first-play-only" | "on-every-play" | undefined; buildFrameGenerators(this: Readonly<Pick<AnimClip<Readonly<StripDuplicateMethodAutocompletion<any>>, AnimClipConfig>, "computeTween">>, ...effectOptions: unknown[]): EffectFrameGeneratorSet; }>>, AnimClipConfig>
                                ),
                                "computeTween",
                            >,
                        >,
                        ...effectOptions: unknown[],
                    ): EffectFrameGeneratorSet;
                },
            >,
        >,
        AnimClipConfig,
    >[]

    The array of animation clips to remove.

  Returns this

removeClipsAt

• removeClipsAt(
      startIndex: number,
      endIndex?: number,
  ): AnimClip<
      Readonly<
          StripDuplicateMethodAutocompletion<
              {
                  defaultConfig?: Partial<unknown> & object;
                  howOftenBuildGenerators?: "on-first-play-only" | "on-every-play";
                  immutableConfig?: Partial<unknown> & object;
                  buildFrameGenerators(
                      this: Readonly<
                          Pick<
                              (
                                  AnimClip<Readonly<StripDuplicateMethodAutocompletion<{ defaultConfig?: (Partial<unknown> & object) | undefined; immutableConfig?: (Partial<unknown> & object) | undefined; howOftenBuildGenerators?: "on-first-play-only" | "on-every-play" | undefined; buildFrameGenerators(this: Readonly<Pick<AnimClip<Readonly<StripDuplicateMethodAutocompletion<any>>, AnimClipConfig>, "computeTween">>, ...effectOptions: unknown[]): EffectFrameGeneratorSet; }>>, AnimClipConfig>
                              ),
                              "computeTween",
                          >,
                      >,
                      ...effectOptions: unknown[],
                  ): EffectFrameGeneratorSet;
              },
          >,
      >,
      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 (if not specified, startIndex + 1 is used, removing one clip).

  Returns AnimClip<
      Readonly<
          StripDuplicateMethodAutocompletion<
              {
                  defaultConfig?: Partial<unknown> & object;
                  howOftenBuildGenerators?: "on-first-play-only" | "on-every-play";
                  immutableConfig?: Partial<unknown> & object;
                  buildFrameGenerators(
                      this: Readonly<
                          Pick<
                              (
                                  AnimClip<Readonly<StripDuplicateMethodAutocompletion<{ defaultConfig?: (Partial<unknown> & object) | undefined; immutableConfig?: (Partial<unknown> & object) | undefined; howOftenBuildGenerators?: "on-first-play-only" | "on-every-play" | undefined; buildFrameGenerators(this: Readonly<Pick<AnimClip<Readonly<StripDuplicateMethodAutocompletion<any>>, AnimClipConfig>, "computeTween">>, ...effectOptions: unknown[]): EffectFrameGeneratorSet; }>>, AnimClipConfig>
                              ),
                              "computeTween",
                          >,
                      >,
                      ...effectOptions: unknown[],
                  ): EffectFrameGeneratorSet;
              },
          >,
      >,
      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: string): this

  Sets the description for this sequence.

  Parameters

  • description: string

    The new description.

  Returns this

  See

  AnimSequenceConfig.description

setJumpTag

• setJumpTag(jumpTag: string): this

  Sets the jumpTag for this sequence.

  Parameters

  • jumpTag: string

    The 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 tasks generated by AnimClip.scheduleTask.
  • 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 tasks generated by AnimClip.scheduleTask.

  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: number): this

  Sets the base playback rate of the sequence.

  Parameters

  • newRate: number

    The new playback rate.

  Returns this

setOnFinish

• setOnFinish(functions: { do: Function; undo: Function }): this

  Parameters

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

  Returns this

setOnStart

• setOnStart(functions: { do: Function; undo: Function }): this

  Parameters

  • functions: { 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,