Project OutFox Wiki
Project OutFox home View the OutFox Wiki source on GitHub Toggle Dark/Light/Auto mode Toggle Dark/Light/Auto mode Toggle Dark/Light/Auto mode Back to homepage

BPMDisplay

A general-purpose BPM display. Can cycle between two states of values in a rolling motion.

Def.BPMDisplay{}

Attributes

There are no special attributes with this actor type. It inherits its attributes from BitmapText.

Functions

These functions also work on SongBPMDisplay.

SetFromGameState

Obtains the current BPM information from the song or course. If the song is from an extra stage, it will report it as a random value instead.

SetFromSong

(Song pSong)

Sets the BPM to the song’s BPM range. This value can be tricked if the chart is using a specified BPM rather than the actual BPM, or even jumbled if it’s tagged as random.

SetFromSteps

(Steps data)

Sets the BPM to the steps’s BPM range. Useful if the current steps contain different timing data.

SetFromCourse

(Course pCourse)

Obtains the BPM range from the course. A couple of rules are applied here:

  • The operation will fail if there are no steps available on the course for the current StepsType.
  • If there are more entries than the value of Common::MaxCourseEntriesBeforeShowVarious (Default: 10), the course is considered various, and instead will output the text defined on BPMDisplay::VariousText (Default: "000").

GetText

Gets the current value that the SongBPMDisplay contains.