Struct peace_performance::FruitsPP

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

Calculator for pp on osu!ctb maps.

Example

let map: Beatmap = ...
let pp_result: PpResult = FruitsPP::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 = FruitsPP::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> FruitsPP<'m>

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

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

FruitsAttributeProvider is implemented by DifficultyAttributes, StarResult, and by PpResult meaning you can give the result of a star calculation or a pp 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 fruits(self, n_fruits: usize) -> Self

Specify the amount of fruits of a play i.e. n300.

pub fn droplets(self, n_droplets: usize) -> Self

Specify the amount of droplets of a play i.e. n100.

pub fn tiny_droplets(self, n_tiny_droplets: usize) -> Self

Specify the amount of tiny droplets of a play i.e. n50.

pub fn tiny_droplet_misses(self, n_tiny_droplet_misses: usize) -> Self

Specify the amount of tiny droplet misses of a play i.e. n_katu.

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

Specify the amount of fruit / droplet misses of the play.

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

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

Be sure to set misses beforehand! Also, if available, set attributes beforehand.

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 calculate(&mut self) -> PpResult

Returns an object which contains the pp and DifficultyAttributes containing stars and other attributes.

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

Trait Implementations

impl<'m> Clone for FruitsPP<'m>

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

Returns a copy of the value.

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

Performs copy-assignment from source.

impl<'m> Debug for FruitsPP<'m>

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

Formats the value using the given formatter.