Struct rosu_pp::FruitsPP

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

Performance calculator on osu!ctb maps.

Example

use rosu_pp::{FruitsPP, Beatmap};

let map: Beatmap = ...

let pp_result = 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<'map> FruitsPP<'map>

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

Create a new performance calculator for osu!ctb maps.

pub fn attributes(self, attributes: impl FruitsAttributeProvider) -> 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 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.

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

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

Provide parameters through an FruitsScoreState.

pub fn accuracy(self, acc: f64) -> 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 calculate(self) -> FruitsPerformanceAttributes

Calculate all performance related values, including pp and stars.

Trait Implementations

impl<'map> Clone for FruitsPP<'map>

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

Returns a copy of the value.

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

Performs copy-assignment from source.

impl<'map> Debug for FruitsPP<'map>

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

Formats the value using the given formatter.