Function $timerSeq

  • $timerSeq<TPhaseName>(params, opts?): BpxTimerSequence<TPhaseName>

  • A shorthand for BpxTimerSequence.of.

    Type Parameters

    • TPhaseName extends string

      Names of the phases used as keys in intro and loop. It allows for a phase name type-checking in the places where the timer sequence is used. Usually you doesn't have to specify those phase names in the template definition, since they are inferred by TypeScript from the intro and loop.

    Parameters

    • params: {
          intro?: [phase: TPhaseName, frames: number][];
          loop?: [phase: TPhaseName, frames: number][];
      }
      • Optionalintro?: [phase: TPhaseName, frames: number][]
      • Optionalloop?: [phase: TPhaseName, frames: number][]
    • Optionalopts: {
          delayFrames?: number;
          onGamePause?: "pause" | "ignore";
          paused?: boolean;
      }
      • OptionaldelayFrames?: number
      • OptionalonGamePause?: "pause" | "ignore"
      • Optionalpaused?: boolean

    Returns BpxTimerSequence<TPhaseName>

    Example

    $timerSeq({
      intro: [
        ["entrance", 8],
      ],
      loop: [
        ["attack1", 60],
        ["pause1", 60],
        ["attack2", 120],
        ["pause2", 90],
      ],
    }, {
      paused: true,
    });

Settings