Enum peace_performance::AnyPP

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

Calculator for pp on maps of any mode.

Variants

Fruits

Tuple Fields of Fruits

0: FruitsPP<'m>

Mania

Tuple Fields of Mania

0: ManiaPP<'m>

Osu

Tuple Fields of Osu

0: OsuPP<'m>

Taiko

Tuple Fields of Taiko

0: TaikoPP<'m>

Implementations

impl<'m> AnyPP<'m>

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

pub async fn calculate(&mut self) -> PpResult

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

AttributeProvider is implemented by StarResult and PpResult meaning you can give the result of a
star calculation or the result of a pp calculation. If you already calculated the stars 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.

pub fn accuracy(self, acc: f32) -> 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 set_accuracy(&mut self, acc: f32)

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.

If it is used to calculate the PP of multiple different ACCs, it should be called from high to low according to the ACC value, otherwise it is invalid.

Examples:

// valid
let acc_100 = {
    c.set_accuracy(100.0);
    c.calculate().await
};
let acc_99 = {
    c.set_accuracy(99.0);
    c.calculate().await
};
let acc_98 = {
    c.set_accuracy(98.0);
    c.calculate().await
};
let acc_95 = {
    c.set_accuracy(95.0);
    c.calculate().await
};
 
// invalid
let acc_95 = {
    c.set_accuracy(95.0);
    c.calculate().await
};
let acc_98 = {
    c.set_accuracy(98.0);
    c.calculate().await
};
let acc_99 = {
    c.set_accuracy(99.0);
    c.calculate().await
};
let acc_100 = {
    c.set_accuracy(100.0);
    c.calculate().await
};

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 represent 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<'m> Clone for AnyPP<'m>

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

Returns a copy of the value.

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

Performs copy-assignment from source.