Struct libosu::beatmap::Beatmap

pub struct Beatmap {

    pub version: u32,
    pub audio_filename: String,
    pub audio_leadin: Millis,
    pub preview_time: Millis,
    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: GridSize,
    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 events: Vec<Event>,
    pub colors: Vec<Color>,
    pub hit_objects: Vec<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: Millis

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

preview_time: Millis

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: GridSize

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.

events: Vec<Event>

Events

colors: Vec<Color>

Overridden combo colors.

hit_objects: Vec<HitObject>

The set of hit objects.

timing_points: Vec<TimingPoint>

The set of timing points.

Implementations

impl Beatmap

pub fn max_combo(&self) -> u32

Get the maximum combo in this map

pub fn double_iter(&self) -> DoubleIter<'_>

Iterate over both hit objects and timing points. See DoubleIter for more info.

pub fn get_hitobject_end_time(&self, ho: &HitObject) -> Option<f64>

Computes the end time of the given hitobject

pub fn get_slider_duration(&self, ho: &HitObject) -> Option<f64>

Returns the slider duration in seconds (including repeats!) for a given slider

pub fn get_slider_velocity_at_time(&self, time: Millis) -> f64

Returns the slider velocity at the given time

pub fn get_bpm_at_time(&self, time: Millis) -> Option<f64>

Returns the BPM at the given time

impl Beatmap

APIs related to parsing and serializing .osu files

pub fn parse(reader: impl Read) -> Result<Beatmap, BeatmapParseError>

Parse a beatmap from any Reader

pub fn write(&self, w: impl Write) -> Result<(), Error>

Write this beatmap to any Writer

impl Beatmap

pub fn locate_timing_point(&self, time: impl Into<Millis>) -> 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<Millis>) -> Option<HitObject>

Returns the hitobject located at the given time.

Trait Implementations

impl Clone for Beatmap

fn clone(&self) -> Beatmap

Returns a copy of the value.

fn clone_from(&mut self, source: &Self)

Performs copy-assignment from source.

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<'de> Deserialize<'de> for Beatmap

fn deserialize<__D>(__deserializer: __D) -> Result<Self, __D::Error> where
    __D: Deserializer<'de>, 

Deserialize this value from the given Serde deserializer.

impl Display for Beatmap

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

Formats the value using the given formatter.

impl FromStr for Beatmap

type Err = BeatmapParseError

The associated error which can be returned from parsing.

fn from_str(input: &str) -> Result<Beatmap, Self::Err>

Parses a string s to return a value of this type.

impl PartialEq<Beatmap> for Beatmap

fn eq(&self, other: &Beatmap) -> bool

This method tests for self and other values to be equal, and is used by ==.

fn ne(&self, other: &Beatmap) -> bool

This method tests for !=.

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.

impl StructuralPartialEq for Beatmap