Struct rosu_pp::Difficulty

pub struct Difficulty { /* private fields */ }

Difficulty calculator on maps of any mode.

Example

use rosu_pp::{Beatmap, Difficulty, any::DifficultyAttributes};

let map = Beatmap::from_path("./resources/2118524.osu").unwrap();

let attrs: DifficultyAttributes = Difficulty::new()
    .mods(8 + 1024) // HDFL
    .calculate(&map);

Implementations

impl Difficulty

pub const fn new() -> Self

Create a new difficulty calculator.

pub const fn with_mode<M: IGameMode>(&self) -> ConvertedDifficulty<'_, M>

Use this Difficulty as a calculator for a specific IGameMode.

Note that ConvertedDifficulty won’t allow to further customize fields so be sure they’re all set before converting to it.

pub fn inspect(self) -> InspectDifficulty

Turn this Difficulty into a InspectDifficulty to inspect its configured values.

pub const fn mods(self, mods: u32) -> Self

Specify mods through their bit values.

See https://github.com/ppy/osu-api/wiki#mods

pub const fn passed_objects(self, passed_objects: u32) -> Self

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

pub fn clock_rate(self, clock_rate: f64) -> Self

Adjust the clock rate used in the calculation.

If none is specified, it will take the clock rate based on the mods i.e. 1.5 for DT, 0.75 for HT and 1.0 otherwise.

Minimum	Maximum
0.01	100

pub fn ar(self, ar: f32, with_mods: bool) -> Self

Override a beatmap’s set AR.

Only relevant for osu! and osu!catch.

with_mods determines if the given value should be used before or after accounting for mods, e.g. on true the value will be used as is and on false it will be modified based on the mods.

Minimum	Maximum
-20	20

pub fn cs(self, cs: f32, with_mods: bool) -> Self

Override a beatmap’s set CS.

Only relevant for osu! and osu!catch.

with_mods determines if the given value should be used before or after accounting for mods, e.g. on true the value will be used as is and on false it will be modified based on the mods.

Minimum	Maximum
-20	20

pub fn hp(self, hp: f32, with_mods: bool) -> Self

Override a beatmap’s set HP.

with_mods determines if the given value should be used before or after accounting for mods, e.g. on true the value will be used as is and on false it will be modified based on the mods.

Minimum	Maximum
-20	20

pub fn od(self, od: f32, with_mods: bool) -> Self

Override a beatmap’s set OD.

with_mods determines if the given value should be used before or after accounting for mods, e.g. on true the value will be used as is and on false it will be modified based on the mods.

Minimum	Maximum
-20	20

pub const fn hardrock_offsets(self, hardrock_offsets: bool) -> Self

Adjust patterns as if the HR mod is enabled.

Only relevant for osu!catch.

pub fn calculate(&self, map: &Beatmap) -> DifficultyAttributes

Perform the difficulty calculation.

pub fn strains(&self, map: &Beatmap) -> Strains

Perform the difficulty calculation but instead of evaluating the skill strains, return them as is.

Suitable to plot the difficulty of a map over time.

pub fn gradual_difficulty(self, map: &Beatmap) -> GradualDifficulty

Create a gradual difficulty calculator for a Beatmap.

pub fn gradual_performance(self, map: &Beatmap) -> GradualPerformance

Create a gradual performance calculator for a Beatmap.

Trait Implementations

impl<M> AsRef<Difficulty> for ConvertedDifficulty<'_, M>

fn as_ref(&self) -> &Difficulty

Converts this type into a shared reference of the (usually inferred) input type.

impl Clone for Difficulty

fn clone(&self) -> Difficulty

Returns a copy of the value.

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

Performs copy-assignment from source.

impl Debug for Difficulty

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

Formats the value using the given formatter.

impl Default for Difficulty

fn default() -> Self

Returns the “default value” for a type.

impl<'a, M: IGameMode> From<&'a Difficulty> for ConvertedDifficulty<'a, M>

fn from(difficulty: &'a Difficulty) -> Self

Converts to this type from the input type.

impl From<Difficulty> for InspectDifficulty

fn from(difficulty: Difficulty) -> Self

Converts to this type from the input type.

impl From<InspectDifficulty> for Difficulty

fn from(difficulty: InspectDifficulty) -> Self

Converts to this type from the input type.

impl PartialEq for Difficulty

fn eq(&self, other: &Difficulty) -> bool

This method tests for self and other values to be equal, and is used by ==.

fn ne(&self, other: &Rhs) -> bool

This method tests for !=. The default implementation is almost always sufficient, and should not be overridden without very good reason.

impl StructuralPartialEq for Difficulty