Struct rosu_pp::ManiaPP

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

Performance calculator on osu!mania maps.

Example

use rosu_pp::{ManiaPP, Beatmap};

let map: Beatmap = ...

let pp_result = ManiaPP::new(&map)
    .mods(64) // DT
    .score(765_432)
    .calculate();

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

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

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

Implementations

impl<'map> ManiaPP<'map>

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

Create a new performance calculator for osu!mania maps.

pub fn attributes(self, attributes: impl ManiaAttributeProvider) -> 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 score(self, score: u32) -> Self

Specify the score of a play. On NoMod its between 0 and 1,000,000, on Easy between 0 and 500,000, etc.

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

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

Be sure you also set score or the final values won’t be correct because it will incorrectly assume a score of 1,000,000.

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

pub fn calculate(self) -> ManiaPerformanceAttributes

Calculate all performance related values, including pp and stars.

Trait Implementations

impl<'map> Clone for ManiaPP<'map>

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

Returns a copy of the value.

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

Performs copy-assignment from source.

impl<'map> Debug for ManiaPP<'map>

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

Formats the value using the given formatter.