Class Course

Represents a course in a song.

Hierarchy

Course

Index

Constructors

Properties

difficulty doubleCourse singleCourse stars

Accessors

activeCourse activeCourseStyle

Methods

addCommand setGauge toString

Constructors

constructor

new Course(): Course
Returns Course

Properties

difficulty

difficulty: Difficulty = Difficulty.Oni

The difficulty of the course.

doubleCourse

doubleCourse: CourseVariant = ...

The DOUBLE style course variant of this course.

singleCourse

singleCourse: CourseVariant = ...

The SINGLE style course variant of this course.

stars

stars: number = 10

The star rating of the course. It is an integer between 1 and 10.

Accessors

activeCourse

get activeCourse(): CourseVariant
Returns the currently selected course variant. It is determined by the active course style.

Returns CourseVariant
- Defined in src/models/course/Course.ts:43

activeCourseStyle

set activeCourseStyle(style: Style): void
Sets the active course style. The activeCourse getter will return the course variant based on this style value.
Parameters
- style: Style
Returns void
- Defined in src/models/course/Course.ts:53

Methods

addCommand

addCommand(command: Command): void
Add a command to the command buffer of the active course variant.
Parameters
- command: Command
  
  The command object to add.
Returns void
- Defined in src/models/course/Course.ts:61

setGauge

setGauge(index: number, gauge: DojoGauge): void
Sets the gauge at a given index to the provided gauge data on the active course variant.
Parameters
- index: number
  
  The index to set.
- gauge: DojoGauge
  
  The gauge data.
Returns void
- Defined in src/models/course/Course.ts:79

toString

toString(): string
Converts the course data into TJA format.

Returns
- A string that will correspond to a single course in a TJA file.
Returns string
- Defined in src/models/course/Course.ts:87

Generated using TypeDoc