Options
All
  • Public
  • Public/Protected
  • All
Menu

Class MapStats

Holds general beatmap statistics for further modifications.

Hierarchy

  • MapStats

Index

Constructors

Properties

Methods

Constructors

constructor

  • new MapStats(values?: { ar?: number; cs?: number; hp?: number; isForceAR?: boolean; mods?: <internal>.Mod[]; od?: number; oldStatistics?: boolean; speedMultiplier?: number }): <internal>.MapStats

  • Parameters

    • Optional values: { ar?: number; cs?: number; hp?: number; isForceAR?: boolean; mods?: <internal>.Mod[]; od?: number; oldStatistics?: boolean; speedMultiplier?: number }
      • Optional ar?: number

        The approach rate of the beatmap.

      • Optional cs?: number

        The circle size of the beatmap.

      • Optional hp?: number

        The health drain rate of the beatmap.

      • Optional isForceAR?: boolean

        Whether or not force AR is turned on.

      • Optional mods?: <internal>.Mod[]

        Applied modifications.

      • Optional od?: number

        The overall difficulty of the beatmap.

      • Optional oldStatistics?: boolean

        Whether to calculate for old statistics for osu!droid gamemode (1.6.7 or older).

      • Optional speedMultiplier?: number

        The speed multiplier to calculate for.

    Returns <internal>.MapStats

Properties

Optional ar

ar?: number

The approach rate of the beatmap.

Optional cs

cs?: number

The circle size of the beatmap.

Optional hp

hp?: number

The health drain rate of the beatmap.

isForceAR

isForceAR: boolean

Whether or not this map statistics uses forced AR.

mods

mods: <internal>.Mod[]

The enabled modifications.

Optional od

od?: number

The overall difficulty of the beatmap.

oldStatistics

oldStatistics: boolean

Whether to calculate for old statistics for osu!droid gamemode (1.6.7 and older). Defaults to false.

speedMultiplier

speedMultiplier: number

The speed multiplier applied from all modifications.

Static Readonly AR0_MS

AR0_MS: number

Static Readonly AR10_MS

AR10_MS: number

Static Readonly AR5_MS

AR5_MS: number

Static Readonly AR_MS_STEP1

AR_MS_STEP1: number

Static Readonly AR_MS_STEP2

AR_MS_STEP2: number

Static Readonly OD0_MS

OD0_MS: number

Static Readonly OD10_MS

OD10_MS: number

Static Readonly OD_MS_STEP

OD_MS_STEP: number

Methods

calculate

  • Calculates map statistics.

    This can only be called once for an instance.

    Parameters

    • Optional params: { isForceAR?: boolean; mode?: <internal>.modes; mods?: string; speedMultiplier?: number }
      • Optional isForceAR?: boolean

        Whether force AR is turned on.

      • Optional mode?: <internal>.modes

        The gamemode to calculate for. Defaults to modes.osu.

      • Optional mods?: string

        The applied modifications in osu!standard format.

      • Optional speedMultiplier?: number

        The speed multiplier to calculate for.

    Returns <internal>.MapStats

toString

  • toString(): string

  • Returns a string representative of the class.

    Returns string

Static arToMS

  • arToMS(ar: number): number

  • Converts an AR value to its milliseconds value.

    Parameters

    • ar: number

      The AR to convert.

    Returns number

    The milliseconds value represented by the AR.

Static modifyAR

  • modifyAR(baseAR: number, speedMultiplier: number, statisticsMultiplier: number): number

  • Utility function to apply speed and flat multipliers to stats where speed changes apply for AR.

    Parameters

    • baseAR: number

      The base AR value.

    • speedMultiplier: number

      The speed multiplier to calculate.

    • statisticsMultiplier: number

      The statistics multiplier to calculate from map-changing nonspeed-changing mods.

    Returns number

Static modifyOD

  • modifyOD(baseOD: number, speedMultiplier: number, statisticsMultiplier: number): number

  • Utility function to apply speed and flat multipliers to stats where speed changes apply for OD.

    Parameters

    • baseOD: number

      The base OD value.

    • speedMultiplier: number

      The speed multiplier to calculate.

    • statisticsMultiplier: number

      The statistics multiplier to calculate from map-changing nonspeed-changing mods.

    Returns number

Generated using TypeDoc