Enum rosu_pp::AnyPP

pub enum AnyPP<'map> {
    Fruits(FruitsPP<'map>),
    Mania(ManiaPP<'map>),
    Osu(OsuPP<'map>),
    Taiko(TaikoPP<'map>),
}

Performance calculator on maps of any mode.

Example

use rosu_pp::{AnyPP, Beatmap};

let map: Beatmap = ...

let pp_result = AnyPP::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 = AnyPP::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());

Variants

Fruits(FruitsPP<'map>)

Tuple Fields

0: FruitsPP<'map>

osu!ctb performance calculator

Mania(ManiaPP<'map>)

Tuple Fields

0: ManiaPP<'map>

osu!mania performance calculator

Osu(OsuPP<'map>)

Tuple Fields

0: OsuPP<'map>

osu!standard performance calculator

Taiko(TaikoPP<'map>)

Tuple Fields

0: TaikoPP<'map>

osu!taiko performance calculator

Implementations

impl<'map> AnyPP<'map>

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

Create a new performance calculator for maps of any mode.

pub fn calculate(self) -> PerformanceAttributes

Consume the performance calculator and calculate performance attributes for the given parameters.

pub fn attributes(self, attributes: impl AttributeProvider) -> 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 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 AnyPP multiple times with different passed_objects, you should use GradualPerformanceAttributes.

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

Provide parameters through a ScoreState.

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

Set the accuracy between 0.0 and 100.0.

For some modes this method depends on previously set values. Be sure to call this last before calling calculate.

Irrelevant for osu!mania.

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

Specify the amount of misses of a play.

Irrelevant for osu!mania.

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

Specify the max combo of the play.

Irrelevant for osu!mania.

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

Specify the amount of 300s of a play.

Irrelevant for osu!mania.

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

Specify the amount of 100s of a play.

Irrelevant for osu!mania.

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

Specify the amount of 50s of a play.

Irrelevant for osu!mania and osu!taiko.

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

Specify the amount of katus of a play.

This value is only relevant for osu!ctb for which it represents the amount of tiny droplet misses.

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

Specify the score of a play.

This value is only relevant for osu!mania.

On NoMod its between 0 and 1,000,000, on Easy between 0 and 500,000, etc.

Trait Implementations

impl<'map> Clone for AnyPP<'map>

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

Returns a copy of the value.

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

Performs copy-assignment from source.

impl<'map> Debug for AnyPP<'map>

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

Formats the value using the given formatter.