Struct rosu_pp::OsuPP

pub struct OsuPP<'map> { /* fields omitted */ }

Performance calculator on osu!standard maps.

Example

use rosu_pp::{OsuPP, Beatmap};

let map: Beatmap = ...

let pp_result = OsuPP::new(&map)
    .mods(8 + 64) // HDDT
    .combo(1234)
    .misses(1)
    .accuracy(98.5) // should be set last
    .calculate();

println!("PP: {} | Stars: {}", pp_result.pp(), pp_result.stars());

let next_result = OsuPP::new(&map)
    .attributes(pp_result)  // reusing previous results for performance
    .mods(8 + 64)           // has to be the same to reuse attributes
    .accuracy(99.5)
    .calculate();

println!("PP: {} | Stars: {}", next_result.pp(), next_result.stars());

Implementations

impl<'map> OsuPP<'map>

pub fn new(map: &'map Beatmap) -> Self

Create a new performance calculator for osu!standard maps.

pub fn attributes(self, attributes: impl OsuAttributeProvider) -> Self

Provide the result of a previous difficulty or performance calculation. If you already calculated the attributes for the current map-mod combination, be sure to put them in here so that they don’t have to be recalculated.

pub fn mods(self, mods: u32) -> Self

Specify mods through their bit values.

See https://github.com/ppy/osu-api/wiki#mods

pub fn combo(self, combo: usize) -> Self

Specify the max combo of the play.

pub fn n300(self, n300: usize) -> Self

Specify the amount of 300s of a play.

pub fn n100(self, n100: usize) -> Self

Specify the amount of 100s of a play.

pub fn n50(self, n50: usize) -> Self

Specify the amount of 50s of a play.

pub fn misses(self, n_misses: usize) -> Self

Specify the amount of misses of a play.

pub fn passed_objects(self, passed_objects: usize) -> Self

Amount of passed objects for partial plays, e.g. a fail.

If you want to calculate the performance after every few objects, instead of using OsuPP multiple times with different passed_objects, you should use OsuGradualPerformanceAttributes.

pub fn state(self, state: OsuScoreState) -> Self

Provide parameters through an OsuScoreState.

pub fn accuracy(self, acc: f64) -> Self

Generate the hit results with respect to the given accuracy between 0 and 100.

Be sure to set misses beforehand! In case of a partial play, be also sure to set passed_objects beforehand!

pub fn calculate(self) -> OsuPerformanceAttributes

Calculate all performance related values, including pp and stars.

Trait Implementations

impl<'map> Clone for OsuPP<'map>

fn clone(&self) -> OsuPP<'map>

Returns a copy of the value.

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

Performs copy-assignment from source.

impl<'map> Debug for OsuPP<'map>

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

Formats the value using the given formatter.