Struct peace_performance::TaikoPP

pub struct TaikoPP<'m> { /* fields omitted */ }

Calculator for pp on osu!taiko maps.

Example

let map: Beatmap = ...
let pp_result: PpResult = TaikoPP::new(&map)
    .mods(8 + 64) // HDDT
    .combo(1234)
    .misses(1)
    .accuracy(98.5)
    .calculate();

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

let next_result = TaikoPP::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<'m> TaikoPP<'m>

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

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

TaikoAttributeProvider is implemented by f32, StarResult, and by PpResult meaning you can give the star rating, 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 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 misses(self, n_misses: usize) -> Self

Specify the amount of misses of the play.

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

Set the accuracy between 0.0 and 100.0.

pub fn set_accuracy(&mut self, acc: f32)

Set acc value

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 passed_objects(self, passed_objects: usize) -> Self

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

pub fn calculate(&mut self) -> PpResult

Returns an object which contains the pp and stars.

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

Trait Implementations

impl<'m> Clone for TaikoPP<'m>

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

Returns a copy of the value.

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

Performs copy-assignment from source.

impl<'m> Debug for TaikoPP<'m>

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

Formats the value using the given formatter.