@rian8337/osu-difficulty-calculator 3.0.0-beta.19 → 3.0.0-beta.20

package/typings/index.d.ts

@@ -312,11 +312,67 @@ declare abstract class StrainSkill extends Skill {
 }
 
 /**
- * Holds additional data that is used in difficulty calculation.
+ * Holds data that can be used to calculate performance points.
  */
 interface DifficultyAttributes {
+    /**
+     * The mods which were applied to the beatmap.
+     */
+    mods: Mod[];
+    /**
+     * The combined star rating of all skills.
+     */
+    starRating: number;
+    /**
+     * The maximum achievable combo.
+     */
+    maxCombo: number;
+    /**
+     * The difficulty corresponding to the aim skill.
+     */
+    aimDifficulty: number;
+    /**
+     * The difficulty corresponding to the flashlight skill.
+     */
+    flashlightDifficulty: number;
+    /**
+     * The number of clickable objects weighted by difficulty.
+     *
+     * Related to speed/tap difficulty.
+     */
     speedNoteCount: number;
+    /**
+     * Describes how much of aim difficulty is contributed to by hitcircles or sliders.
+     *
+     * A value closer to 1 indicates most of aim difficulty is contributed by hitcircles.
+     *
+     * A value closer to 0 indicates most of aim difficulty is contributed by sliders.
+     */
     sliderFactor: number;
+    /**
+     * The perceived approach rate inclusive of rate-adjusting mods (DT/HT/etc).
+     *
+     * Rate-adjusting mods don't directly affect the approach rate difficulty value, but have a perceived effect as a result of adjusting audio timing.
+     */
+    approachRate: number;
+    /**
+     * The perceived overall difficulty inclusive of rate-adjusting mods (DT/HT/etc), based on osu!standard judgement.
+     *
+     * Rate-adjusting mods don't directly affect the overall difficulty value, but have a perceived effect as a result of adjusting audio timing.
+     */
+    overallDifficulty: number;
+    /**
+     * The number of hitcircles in the beatmap.
+     */
+    hitCircleCount: number;
+    /**
+     * The number of sliders in the beatmap.
+     */
+    sliderCount: number;
+    /**
+     * The number of spinners in the beatmap.
+     */
+    spinnerCount: number;
 }
 
 /**
@@ -370,9 +426,9 @@ declare abstract class DifficultyCalculator {
      */
     readonly strainPeaks: StrainPeaks;
     /**
-     * Additional data that is used in performance calculation.
+     * Holds data that can be used to calculate performance points.
      */
-    readonly attributes: DifficultyAttributes;
+    abstract readonly attributes: DifficultyAttributes;
     protected readonly sectionLength: number;
     protected abstract readonly difficultyMultiplier: number;
     protected abstract readonly mode: Modes;
@@ -424,6 +480,10 @@ declare abstract class DifficultyCalculator {
      * Creates skills to be calculated.
      */
     protected abstract createSkills(): StrainSkill[];
+    /**
+     * Populates the stored difficulty attributes with necessary data.
+     */
+    protected populateDifficultyAttributes(): void;
     /**
      * Calculates the star rating value of a difficulty.
      *
@@ -552,6 +612,24 @@ declare abstract class DroidAimEvaluator extends AimEvaluator {
     private static movementStrainOf;
 }
 
+/**
+ * Holds data that can be used to calculate osu!droid performance points.
+ */
+interface DroidDifficultyAttributes extends DifficultyAttributes {
+    /**
+     * The difficulty corresponding to the tap skill.
+     */
+    tapDifficulty: number;
+    /**
+     * The difficulty corresponding to the rhythm skill.
+     */
+    rhythmDifficulty: number;
+    /**
+     * The difficulty corresponding to the visual skill.
+     */
+    visualDifficulty: number;
+}
+
 /**
  * A difficulty calculator for osu!droid gamemode.
  */
@@ -578,6 +656,7 @@ declare class DroidDifficultyCalculator extends DifficultyCalculator {
     visual: number;
     protected readonly difficultyMultiplier: number;
     protected readonly mode: Modes;
+    readonly attributes: DroidDifficultyAttributes;
     /**
      * Calculates the aim star rating of the beatmap and stores it in this instance.
      */
@@ -715,7 +794,7 @@ interface PerformanceCalculationOptions {
 /**
  * The base class of performance calculators.
  */
-declare abstract class PerformanceCalculator<T extends DifficultyCalculator> {
+declare abstract class PerformanceCalculator {
     /**
      * The overall performance value.
      */
@@ -725,9 +804,9 @@ declare abstract class PerformanceCalculator<T extends DifficultyCalculator> {
      */
     computedAccuracy: Accuracy;
     /**
-     * The difficulty calculator that is being calculated.
+     * The difficulty attributes that is being calculated.
      */
-    readonly difficultyCalculator: T;
+    abstract readonly difficultyAttributes: DifficultyAttributes;
     /**
      * Penalty for combo breaks.
      */
@@ -750,10 +829,6 @@ declare abstract class PerformanceCalculator<T extends DifficultyCalculator> {
      * Nerf factor used for nerfing beatmaps with very likely dropped sliderends.
      */
     protected sliderNerfFactor: number;
-    /**
-     * @param difficultyCalculator The difficulty calculator to calculate.
-     */
-    constructor(difficultyCalculator: T);
     /**
      * Calculates the performance points of the beatmap.
      *
@@ -774,6 +849,10 @@ declare abstract class PerformanceCalculator<T extends DifficultyCalculator> {
      * Calculates the total performance value of the beatmap and stores it in this instance.
      */
     protected abstract calculateTotalValue(): void;
+    /**
+     * The total hits that can be done in the beatmap.
+     */
+    protected get totalHits(): number;
     /**
      * Calculates the base performance value of a star rating.
      */
@@ -793,7 +872,7 @@ declare abstract class PerformanceCalculator<T extends DifficultyCalculator> {
 /**
  * A performance points calculator that calculates performance points for osu!droid gamemode.
  */
-declare class DroidPerformanceCalculator extends PerformanceCalculator<DroidDifficultyCalculator> {
+declare class DroidPerformanceCalculator extends PerformanceCalculator {
     /**
      * The aim performance value.
      */
@@ -821,8 +900,13 @@ declare class DroidPerformanceCalculator extends PerformanceCalculator<DroidDiff
      */
     get tapPenalty(): number;
     private _tapPenalty;
+    readonly difficultyAttributes: DroidDifficultyAttributes;
     protected finalMultiplier: number;
     protected readonly mode: Modes;
+    /**
+     * @param difficultyAttributes The difficulty attributes to calculate.
+     */
+    constructor(difficultyAttributes: DroidDifficultyAttributes);
     /**
      * Applies a tap penalty value to this calculator.
      *
@@ -1010,6 +1094,16 @@ declare abstract class OsuSkill extends StrainSkill {
     difficultyValue(): number;
 }
 
+/**
+ * Holds data that can be used to calculate osu!standard performance points.
+ */
+interface OsuDifficultyAttributes extends DifficultyAttributes {
+    /**
+     * The difficulty corresponding to the speed skill.
+     */
+    speedDifficulty: number;
+}
+
 /**
  * A difficulty calculator for osu!standard gamemode.
  */
@@ -1026,6 +1120,7 @@ declare class OsuDifficultyCalculator extends DifficultyCalculator {
      * The flashlight star rating of the beatmap.
      */
     flashlight: number;
+    readonly attributes: OsuDifficultyAttributes;
     protected readonly difficultyMultiplier: number;
     protected readonly mode: Modes;
     /**
@@ -1183,7 +1278,7 @@ declare abstract class OsuFlashlightEvaluator extends FlashlightEvaluator {
 /**
  * A performance points calculator that calculates performance points for osu!standard gamemode.
  */
-declare class OsuPerformanceCalculator extends PerformanceCalculator<OsuDifficultyCalculator> {
+declare class OsuPerformanceCalculator extends PerformanceCalculator {
     /**
      * The aim performance value.
      */
@@ -1200,8 +1295,13 @@ declare class OsuPerformanceCalculator extends PerformanceCalculator<OsuDifficul
      * The flashlight performance value.
      */
     flashlight: number;
+    readonly difficultyAttributes: OsuDifficultyAttributes;
     protected finalMultiplier: number;
     protected readonly mode: Modes;
+    /**
+     * @param difficultyAttributes The difficulty attributes to calculate.
+     */
+    constructor(difficultyAttributes: OsuDifficultyAttributes);
     protected calculateValues(): void;
     protected calculateTotalValue(): void;
     /**