Options
All
  • Public
  • Public/Protected
  • All
Menu

Class Storyboard

A beatmap storyboard.

Hierarchy

  • Storyboard

Index

Constructors

Properties

colors: BeatmapColorSection = ...

Custom beatmap colors.

fileFormat: number = 14

Beatmap file version for which this storyboard was created.

minimumLayerDepth: number = 0

Depth of the currently front-most storyboard layer, excluding the overlay layer.

useSkinSprites: boolean = false

Whether the storyboard can fall back to skin sprites in case no matching storyboard sprites are found.

variables: Map<string, string> = ...

Variables of the storyboard.

Accessors

  • get earliestEventTime(): null | number
  • Across all layers, find the earliest point in time that a storyboard element exists at. Will return null if there are no elements. This iterates all elements and as such should be used sparingly or stored locally.

    Returns null | number

  • get hasDrawable(): boolean
  • get hasVariables(): boolean
  • get latestEventTime(): null | number
  • Across all layers, find the latest point in time that a storyboard element ends at. Will return null if there are no elements. This iterates all elements and as such should be used sparingly or stored locally. Videos and samples return start time as their end time.

    Returns null | number

Methods

  • Finds a storyboard layer by its name. Otherwise will create a new storyboard layer with this name.

    Parameters

    • name: string

      The name of the storyboard layer.

    Returns StoryboardLayer

    The storyboard layer.