The aim difficulty rating of the beatmap.
The ranking status of the beatmap.
The approach rate of the beatmap.
The artist of the song of the beatmap.
The ID of the beatmap.
The ID of the beatmapset containing the beatmap.
The BPM of the beatmap.
The amount of circles in the beatmap.
The creator of the beatmap.
The circle size of the beatmap.
The amount of times the beatmap has been favorited.
The MD5 hash of the beatmap.
The duration of the beatmap not including breaks.
The health drain rate of the beatmap.
The date of which the beatmap was last updated.
The maximum combo of the beatmap.
The overall difficulty of the beatmap.
The beatmap packs that contain this beatmap, represented by their ID.
The amount of times the beatmap has been played.
The amount of sliders in the beatmap.
The source of the song, if any.
The speed difficulty rating of the beatmap.
The amount of spinners in the beatmap.
Whether or not this beatmap has a storyboard.
The date of which the beatmap was submitted.
The title of the song of the beatmap.
The generic difficulty rating of the beatmap.
The duration of the beatmap including breaks.
The difficulty name of the beatmap.
Whether or not this beatmap has a video.
The full title of the beatmap, which is Artist - Title (Creator) [Difficulty Name]
.
The amount of objects in the beatmap.
Returns a color integer based on the beatmap's ranking status.
Useful to make embed messages.
Converts the beatmap's BPM if speed-changing mods are applied.
Converts the beatmap's status into a string.
Converts the beatmap's length if speed-changing mods are applied.
Fills the current instance with map data.
The map data.
Checks whether the beatmap file has been downloaded.
Retrieves the .osu file of the beatmap.
After this, you can use the hasDownloadedBeatmap
method to check if the beatmap has been downloaded.
Whether to download the file regardless if it's already available.
Shows the beatmap's statistics based on applied statistics and option.
0
: return map title and mods used if defined1
: return song source and map download link to beatmap mirrors2
: return circle, slider, and spinner count3
: return CS, AR, OD, HP, and max score statistics for droid4
: return CS, AR, OD, HP, and max score statistics for PC5
: return BPM, map length, and max combo6
: return last update date and map status7
: return favorite count and play countThe option to pick.
The custom statistics to apply. This will only be used to apply mods, custom speed multiplier, and force AR.
Returns a string representative of the class.
Retrieve a beatmap's general information.
The ID of the beatmap.
Whether to also retrieve the .osu file of the beatmap. Defaults to true
.
The beatmap, null
if the beatmap is not found or the beatmap is not an osu!standard beatmap.
Retrieve a beatmap's general information.
The ID of the beatmap.
Whether to also retrieve the .osu file of the beatmap. Defaults to true
.
The beatmap, null
if the beatmap is not found or the beatmap is not an osu!standard beatmap.
Retrieve a beatmap's general information.
The MD5 hash of the beatmap.
Whether to also retrieve the .osu file of the beatmap. Defaults to true
.
The beatmap, null
if the beatmap is not found or the beatmap is not an osu!standard beatmap.
Retrieve a beatmap's general information.
The MD5 hash of the beatmap.
Whether to also retrieve the .osu file of the beatmap. Defaults to true
.
The beatmap, null
if the beatmap is not found or the beatmap is not an osu!standard beatmap.
Generated using TypeDoc
Represents a beatmap with general information.