Struct libosu::Beatmap

pub struct Beatmap {
    pub version: u32,
    pub audio_filename: String,
    pub audio_leadin: u32,
    pub preview_time: u32,
    pub countdown: bool,
    pub sample_set: SampleSet,
    pub stack_leniency: f64,
    pub mode: Mode,
    pub letterbox_in_breaks: bool,
    pub widescreen_storyboard: bool,
    pub difficulty: Difficulty,
    pub bookmarks: Vec<i32>,
    pub distance_spacing: f64,
    pub beat_divisor: u8,
    pub grid_size: u8,
    pub timeline_zoom: f64,
    pub title: String,
    pub title_unicode: String,
    pub artist: String,
    pub artist_unicode: String,
    pub creator: String,
    pub difficulty_name: String,
    pub source: String,
    pub tags: Vec<String>,
    pub beatmap_id: i32,
    pub beatmap_set_id: i32,
    pub colors: Vec<Color>,
    pub hit_objects: BTreeSet<HitObject>,
    pub timing_points: Vec<TimingPoint>,
}

Represents a single beatmap.

Fields

version: u32

The osu! file format being used

audio_filename: String

The name of the audio file to use, relative to the beatmap file.

audio_leadin: u32

The amount of time (in milliseconds) added before the audio file begins playing. Useful for audio files that begin immediately.

preview_time: u32

When (in milliseconds) the audio file should begin playing when selected in the song selection menu.

countdown: bool

Whether or not to show the countdown

sample_set: SampleSet

The default sample set for hit objects which don't have a custom override.

stack_leniency: f64

Leniency for stacked objects.

mode: Mode

The game mode (standard, taiko, catch the beat, mania).

letterbox_in_breaks: bool

Whether or not to show black borders during breaks.

widescreen_storyboard: bool

TODO: unknown field

difficulty: Difficulty

An instance of the difficulty settings.

bookmarks: Vec<i32>

Bookmarks in the editor

distance_spacing: f64

The last setting used for distance spacing.

beat_divisor: u8

The last setting used for beat divisor

grid_size: u8

The last setting used for grid size

timeline_zoom: f64

The last setting used for timeline zoom

title: String

The title of the song (ASCII only).

title_unicode: String

The title of the song (UTF-8).

artist: String

The artist of the song (ASCII only).

artist_unicode: String

The artist of the song (UTF-8).

creator: String

The creator of the mapset.

difficulty_name: String

The name of the difficulty.

source: String

Optional source.

tags: Vec<String>

Optional tags.

beatmap_id: i32

The beatmap ID on Bancho.

beatmap_set_id: i32

The beatmap set ID on Bancho.

colors: Vec<Color>

Overridden combo colors.

hit_objects: BTreeSet<HitObject>

The set of hit objects.

timing_points: Vec<TimingPoint>

The set of timing points.

Methods

impl Beatmap

pub fn locate_timing_point(     &self,     time: impl Into<TimeLocation> ) -> Option<TimingPoint>

Returns the timing point associated with the timing section to which the given time belongs.`

pub fn locate_hitobject(     &self,     time: impl Into<TimeLocation> ) -> Option<HitObject>

Returns the hitobject located at the given time.

pub fn set_hitsound(     &mut self,     time: impl Into<TimeLocation>,     hitsound: &Hitsound )

Set a hitsound at the given time.

Important traits for Vec<u8>

impl Write for Vec<u8>

pub fn get_hitobjects(&self) -> Vec<HitObject>

Get a list of all hit objects.

pub fn get_hitsounds(&self) -> Result<Vec<(i32, Hitsound)>, Error>

Returns a list of this beatmap's hitsounds.

This will also return hitsounds that occur on parts of objects, for example on slider bodies or slider ends. If a hitsound occurs on a spinner, the only "sound" that's counted is the moment that the spinner ends.

impl Beatmap

pub fn from_osz(     input: impl AsRef<str> ) -> Result<Beatmap, Error>

Creates a Beatmap from the *.osz format

pub fn as_osz(&self) -> Result<String, Error>

Serializes this Beatmap into the *.osz format.

Trait Implementations

impl Debug for Beatmap

fn fmt(&self, f: &mut Formatter) -> Result

Formats the value using the given formatter.

impl Default for Beatmap

fn default() -> Self

Returns the "default value" for a type.

impl Serialize for Beatmap

fn serialize<S>(&self, serializer: S) -> Result<S::Ok, S::Error> where     S: Serializer,

Serialize this value into the given Serde serializer.