@rian8337/osu-difficulty-calculator 4.0.0-beta.52 → 4.0.0-beta.53

package/dist/index.js

@@ -43,6 +43,15 @@ class DifficultyCalculator {
         };
         this.beatmap = beatmap;
     }
+    /**
+     * Retains `Mod`s that adjust a beatmap's difficulty from the specified mods.
+     *
+     * @param mods The mods to retain the difficulty adjustment mods from.
+     * @returns The retained difficulty adjustment mods.
+     */
+    static retainDifficultyAdjustmentMods(mods) {
+        return mods.filter((mod) => this.difficultyAdjustmentMods.has(mod.constructor));
+    }
     /**
      * Calculates the star rating of the specified beatmap.
      *
@@ -144,6 +153,10 @@ class DifficultyCalculator {
         return Math.pow(5 * Math.max(1, rating / 0.0675) - 4, 3) / 100000;
     }
 }
+/**
+ * `Mod`s that adjust the difficulty of a beatmap.
+ */
+DifficultyCalculator.difficultyAdjustmentMods = new Set();
 
 /**
  * Represents a hit object with difficulty calculation values.
@@ -2162,6 +2175,21 @@ class DroidDifficultyCalculator extends DifficultyCalculator {
  * Increasing this number will result in less sections being flagged.
  */
 DroidDifficultyCalculator.threeFingerStrainThreshold = 175;
+DroidDifficultyCalculator.difficultyAdjustmentMods = new Set([
+    osuBase.ModDoubleTime,
+    osuBase.ModNightCore,
+    osuBase.ModDifficultyAdjust,
+    osuBase.ModHalfTime,
+    osuBase.ModEasy,
+    osuBase.ModHardRock,
+    osuBase.ModFlashlight,
+    osuBase.ModHidden,
+    osuBase.ModRelax,
+    osuBase.ModAutopilot,
+    osuBase.ModPrecise,
+    osuBase.ModScoreV2,
+    osuBase.ModTraceable,
+]);
 
 /**
  * The base class of performance calculators.
@@ -3745,6 +3773,19 @@ class OsuDifficultyCalculator extends DifficultyCalculator {
         }
     }
 }
+OsuDifficultyCalculator.difficultyAdjustmentMods = new Set([
+    osuBase.ModTouchDevice,
+    osuBase.ModDoubleTime,
+    osuBase.ModNightCore,
+    osuBase.ModDifficultyAdjust,
+    osuBase.ModHalfTime,
+    osuBase.ModEasy,
+    osuBase.ModHardRock,
+    osuBase.ModFlashlight,
+    osuBase.ModHidden,
+    osuBase.ModRelax,
+    osuBase.ModAutopilot,
+]);
 
 /**
  * A performance points calculator that calculates performance points for osu!standard gamemode.

package/package.json

@@ -1,6 +1,6 @@
 {
     "name": "@rian8337/osu-difficulty-calculator",
-    "version": "4.0.0-beta.52",
+    "version": "4.0.0-beta.53",
     "description": "A module for calculating osu!standard beatmap difficulty and performance value with respect to the current difficulty and performance algorithm.",
     "keywords": [
         "osu",
@@ -38,5 +38,5 @@
     "publishConfig": {
         "access": "public"
     },
-    "gitHead": "c7cd2019227c891e7897245ee61d1e24d7a5fb9c"
+    "gitHead": "f35904075742e0f04b295c304bd7d81d11d2b99d"
 }

package/typings/index.d.ts

@@ -1,4 +1,4 @@
-import { Mod, PlaceableHitObject, Modes, Beatmap, Accuracy } from '@rian8337/osu-base';
+import { Mod, PlaceableHitObject, Modes, Beatmap, ModHidden, ModPrecise, ModTraceable, ModScoreV2, ModDoubleTime, ModNightCore, ModDifficultyAdjust, ModHalfTime, ModEasy, ModHardRock, ModFlashlight, ModRelax, ModAutopilot, Accuracy, ModTouchDevice } from '@rian8337/osu-base';
 
 /**
  * Holds data that can be used to calculate performance points.
@@ -340,6 +340,10 @@ declare abstract class DifficultyCalculator<THitObject extends DifficultyHitObje
      * The difficulty attributes that can be cached. It can also be used to calculate performance points.
      */
     abstract get cacheableAttributes(): CacheableDifficultyAttributes<TAttributes>;
+    /**
+     * `Mod`s that adjust the difficulty of a beatmap.
+     */
+    protected static readonly difficultyAdjustmentMods: Set<typeof Mod>;
     protected abstract readonly difficultyMultiplier: number;
     protected abstract readonly mode: Modes;
     /**
@@ -348,6 +352,13 @@ declare abstract class DifficultyCalculator<THitObject extends DifficultyHitObje
      * @param beatmap The beatmap to calculate.
      */
     constructor(beatmap: Beatmap);
+    /**
+     * Retains `Mod`s that adjust a beatmap's difficulty from the specified mods.
+     *
+     * @param mods The mods to retain the difficulty adjustment mods from.
+     * @returns The retained difficulty adjustment mods.
+     */
+    static retainDifficultyAdjustmentMods(mods: Mod[]): Mod[];
     /**
      * Calculates the star rating of the specified beatmap.
      *
@@ -832,6 +843,7 @@ declare class DroidDifficultyCalculator extends DifficultyCalculator<DroidDiffic
     static readonly threeFingerStrainThreshold = 175;
     readonly attributes: ExtendedDroidDifficultyAttributes;
     get cacheableAttributes(): CacheableDifficultyAttributes<DroidDifficultyAttributes>;
+    protected static readonly difficultyAdjustmentMods: Set<typeof ModHidden | typeof ModPrecise | typeof ModTraceable | typeof ModScoreV2 | typeof ModDoubleTime | typeof ModNightCore | typeof ModDifficultyAdjust | typeof ModHalfTime | typeof ModEasy | typeof ModHardRock | typeof ModFlashlight | typeof ModRelax | typeof ModAutopilot>;
     protected readonly difficultyMultiplier = 0.18;
     protected readonly mode = Modes.droid;
     calculate(options?: DroidDifficultyCalculationOptions): this;
@@ -1499,6 +1511,7 @@ declare class OsuDifficultyCalculator extends DifficultyCalculator<OsuDifficulty
     get flashlight(): number;
     readonly attributes: OsuDifficultyAttributes;
     get cacheableAttributes(): CacheableDifficultyAttributes<OsuDifficultyAttributes>;
+    protected static readonly difficultyAdjustmentMods: Set<typeof ModHidden | typeof ModDoubleTime | typeof ModNightCore | typeof ModDifficultyAdjust | typeof ModHalfTime | typeof ModEasy | typeof ModHardRock | typeof ModFlashlight | typeof ModRelax | typeof ModAutopilot | typeof ModTouchDevice>;
     protected readonly difficultyMultiplier = 0.0675;
     protected readonly mode = Modes.osu;
     /**