Class CourseVariant

Represents a single course variant (single or double) in a TJA chart file.

Hierarchy

  • CourseVariant

Constructors

Properties

balloonCounts: number[] = []

Comma separated array of integers for Balloon notes (7) and Kusudama notes (9). Required when balloon notes appear in the course. Amount of values in the array should correspond to the amount of balloons in the course. The balloon values are used as they appear in the chart and the values have to be repeated when branches are used.

branchBalloonCounts: Record<BranchType, number[]> = ...

Comma separated array of integers for Balloon notes (7) and Kusudama notes (9) for each branch in a course with diverge notes. Follows the same set of rules as the balloonCounts property.

gaugeIncrementMethod?: DojoGaugeIncrementMethod

Gauge increment method, performing rounding with each note that is hit.

gaugeTotal?: DojoGaugeTotal

Percentage multiplier for amount of notes in the song notation that is applied to gauge calculation.

gauges: [null | DojoGauge, null | DojoGauge, null | DojoGauge] = ...

Information related to the 3 gauges in a dojo course.

hasBalloonNotes: boolean = false

Whether the course has balloon or kusudama notes.

hasBranches: boolean = false

Whether the course has branches. This is not affected by the hiddenBranches property.

hasDrumroll: boolean = false

Whether the course has any kind of drumroll notes. Balloon notes are not included.

hiddenBranches: boolean = false

Hide the diverge notes indication on the song selection screen and current branch in the game until branching actually starts.

scoreDiff: number = 100

Sets DIFF value for the scoring method.

scoreInit: number = 390

Sets INIT value for the scoring method.

style: Style = Style.Single

Play the song notation after next #START depending on if playing in singleplayer or multiplayer.

Methods

  • Returns the command buffer. When the course variant has the Single style, the command buffer for the single variant will be returned. Otherwise, the command buffer for the specified player will be returned, or the first player's command buffer if no player is specified.

    Returns

    An array of commands and note sequences.

    Parameters

    • Optional player: Player

      An optional player to get the command buffer for when the course variant has the Double style. If not provided, P1 commands will be returned.

    Returns Command[]

  • Checks whether all command buffers are empty. This is useful for filtering out course variants that aren't actually part of the TJA file.

    Returns

    True if all command buffers are empty, false otherwise.

    Returns boolean

  • Converts the course variant into TJA format.

    Returns

    • A string that will correspond to a single course variant in a TJA file.

    Returns string

Generated using TypeDoc