Struct 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 fn inspect(self) -> InspectDifficulty

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

pub fn mods(self, mods: impl Into<GameMods>) -> Self

Specify mods.

Accepted types are

• u32
• rosu_mods::GameModsLegacy
• rosu_mods::GameMods
• rosu_mods::GameModsIntermode
• &rosu_mods::GameModsIntermode

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 const fn ar(self, ar: f32, fixed: bool) -> Self

Override a beatmap’s set AR.

Only relevant for osu! and osu!catch.

fixed 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 cs(self, cs: f32, fixed: bool) -> Self

Override a beatmap’s set CS.

Only relevant for osu! and osu!catch.

fixed 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 hp(self, hp: f32, fixed: bool) -> Self

Override a beatmap’s set HP.

fixed 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 od(self, od: f32, fixed: bool) -> Self

Override a beatmap’s set OD.

fixed 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 const fn lazer(self, lazer: bool) -> Self

Whether the calculated attributes belong to an osu!lazer or osu!stable score.

Defaults to true.

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

Perform the difficulty calculation.

pub fn checked_calculate( &self, map: &Beatmap, ) -> Result<DifficultyAttributes, TooSuspicious>

Perform the difficulty calculation after verifying the map is not suspicious.

pub fn calculate_for_mode<M: IGameMode>( &self, map: &Beatmap, ) -> Result<M::DifficultyAttributes, ConvertError>

Perform the difficulty calculation for a specific IGameMode.

pub fn checked_calculate_for_mode<M: IGameMode>( &self, map: &Beatmap, ) -> Result<M::DifficultyAttributes, CalculateError>

Same as Difficulty::calculate_for_mode but verifies that the Beatmap is not too suspicious for further 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 checked_strains(&self, map: &Beatmap) -> Result<Strains, TooSuspicious>

Perform the strain calculation after verifying the map is not suspicious.

See Difficulty::strains.

pub fn strains_for_mode<M: IGameMode>( &self, map: &Beatmap, ) -> Result<M::Strains, ConvertError>

Perform the strain calculation for a specific IGameMode.

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

Create a gradual difficulty calculator for a Beatmap.

pub fn checked_gradual_difficulty( self, map: &Beatmap, ) -> Result<GradualDifficulty, TooSuspicious>

Same as Difficulty::gradual_difficulty but verifies that the map is not suspicious.

pub fn gradual_difficulty_for_mode<M: IGameMode>( self, map: &Beatmap, ) -> Result<M::GradualDifficulty, ConvertError>

Create a gradual difficulty calculator for a Beatmap on a specific IGameMode.

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

Create a gradual performance calculator for a Beatmap.

pub fn checked_gradual_performance( self, map: &Beatmap, ) -> Result<GradualPerformance, TooSuspicious>

Same as Difficulty::gradual_performance but verifies that the map is not suspicious.

pub fn gradual_performance_for_mode<M: IGameMode>( self, map: &Beatmap, ) -> Result<M::GradualPerformance, ConvertError>

Create a gradual performance calculator for a Beatmap on a specific IGameMode.

Trait Implementations

impl Clone for Difficulty

fn clone(&self) -> Difficulty

Returns a duplicate 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 From<&Difficulty> for BeatmapAttributesBuilder

fn from(difficulty: &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

Tests for self and other values to be equal, and is used by ==.

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

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

impl StructuralPartialEq for Difficulty