@rian8337/osu-difficulty-calculator 4.0.0-beta.56 → 4.0.0-beta.58

package/dist/index.js

@@ -7,7 +7,7 @@ var osuBase = require('@rian8337/osu-base');
  */
 class DifficultyAttributes {
     constructor(cacheableAttributes) {
-        this.mods = [];
+        this.mods = new osuBase.ModMap();
         this.starRating = 0;
         this.maxCombo = 0;
         this.aimDifficulty = 0;
@@ -47,7 +47,7 @@ class DifficultyAttributes {
      * @returns The cacheable attributes.
      */
     toCacheableAttributes() {
-        return Object.assign(Object.assign({}, this), { mods: osuBase.ModUtil.serializeMods(this.mods) });
+        return Object.assign(Object.assign({}, this), { mods: this.mods.serializeMods() });
     }
     /**
      * Returns a string representation of the difficulty attributes.
@@ -79,7 +79,7 @@ class DifficultyCalculator {
             osuBase.ModAutopilot,
         ]);
     }
-    calculate(beatmap, mods = []) {
+    calculate(beatmap, mods) {
         const playableBeatmap = beatmap instanceof osuBase.PlayableBeatmap
             ? beatmap
             : this.createPlayableBeatmap(beatmap, mods);
@@ -92,7 +92,7 @@ class DifficultyCalculator {
         }
         return this.createDifficultyAttributes(playableBeatmap, skills, objects);
     }
-    calculateStrainPeaks(beatmap, mods = []) {
+    calculateStrainPeaks(beatmap, mods) {
         const playableBeatmap = beatmap instanceof osuBase.PlayableBeatmap
             ? beatmap
             : this.createPlayableBeatmap(beatmap, mods);
@@ -283,7 +283,7 @@ class DifficultyHitObject {
         }
         const fadeInStartTime = this.object.startTime - this.object.timePreempt;
         const fadeInDuration = this.object.timeFadeIn;
-        if (mods.some((m) => m instanceof osuBase.ModHidden)) {
+        if (mods.has(osuBase.ModHidden)) {
             const fadeOutStartTime = fadeInStartTime + fadeInDuration;
             const fadeOutDuration = this.object.timePreempt * osuBase.ModHidden.fadeOutDurationMultiplier;
             return Math.min(osuBase.MathUtils.clamp((time - fadeInStartTime) / fadeInDuration, 0, 1), 1 -
@@ -568,8 +568,7 @@ class DroidDifficultyHitObject extends DifficultyHitObject {
     }
     opacityAt(time, mods) {
         // Traceable hides the primary piece of a hit circle (that is, its body), so consider it as fully invisible.
-        if (this.object instanceof osuBase.Circle &&
-            mods.some((m) => m instanceof osuBase.ModTraceable)) {
+        if (this.object instanceof osuBase.Circle && mods.has(osuBase.ModTraceable)) {
             return 0;
         }
         return super.opacityAt(time, mods);
@@ -1178,10 +1177,10 @@ class DroidFlashlightEvaluator {
         }
         result = Math.pow(smallDistNerf * result, 2);
         // Additional bonus for Hidden due to there being no approach circles.
-        if (mods.some((m) => m instanceof osuBase.ModHidden)) {
+        if (mods.has(osuBase.ModHidden)) {
             result *= 1 + this.hiddenBonus;
         }
-        else if (mods.some((m) => m instanceof osuBase.ModTraceable)) {
+        else if (mods.has(osuBase.ModTraceable)) {
             // Additional bonus for Traceable due to there being no primary or secondary object pieces.
             if (current.object instanceof osuBase.Circle) {
                 // Additional bonus for hit circles due to there being no circle piece, which is the primary piece.
@@ -1465,7 +1464,7 @@ class DroidRhythm extends DroidSkill {
         this.starsPerDouble = 1.75;
         this.currentRhythmStrain = 0;
         this.currentRhythmMultiplier = 1;
-        this.useSliderAccuracy = mods.some((m) => m instanceof osuBase.ModScoreV2);
+        this.useSliderAccuracy = mods.has(osuBase.ModScoreV2);
     }
     strainValueAt(current) {
         this.currentRhythmMultiplier =
@@ -1649,10 +1648,10 @@ class DroidVisualEvaluator {
         // Start with base density and give global bonus for Hidden and Traceable.
         // Add density caps for sanity.
         let strain;
-        if (mods.some((m) => m instanceof osuBase.ModHidden)) {
+        if (mods.has(osuBase.ModHidden)) {
             strain = Math.min(30, Math.pow(current.noteDensity, 3));
         }
-        else if (mods.some((m) => m instanceof osuBase.ModTraceable)) {
+        else if (mods.has(osuBase.ModTraceable)) {
             // Give more bonus for hit circles due to there being no circle piece.
             if (current.object instanceof osuBase.Circle) {
                 strain = Math.min(25, Math.pow(current.noteDensity, 2.5));
@@ -1812,7 +1811,7 @@ class DroidDifficultyCalculator extends DifficultyCalculator {
     }
     createDifficultyAttributes(beatmap, skills, objects) {
         const attributes = new ExtendedDroidDifficultyAttributes();
-        attributes.mods = beatmap.mods.slice();
+        attributes.mods = beatmap.mods;
         attributes.maxCombo = beatmap.maxCombo;
         attributes.clockRate = beatmap.speedMultiplier;
         attributes.hitCircleCount = beatmap.hitObjects.circles;
@@ -1823,14 +1822,14 @@ class DroidDifficultyCalculator extends DifficultyCalculator {
         this.populateRhythmAttributes(attributes, skills);
         this.populateFlashlightAttributes(attributes, skills);
         this.populateVisualAttributes(attributes, skills);
-        if (attributes.mods.some((m) => m instanceof osuBase.ModRelax)) {
+        if (beatmap.mods.has(osuBase.ModRelax)) {
             attributes.aimDifficulty *= 0.9;
             attributes.tapDifficulty = 0;
             attributes.rhythmDifficulty = 0;
             attributes.flashlightDifficulty *= 0.7;
             attributes.visualDifficulty = 0;
         }
-        else if (attributes.mods.some((m) => m instanceof osuBase.ModAutopilot)) {
+        else if (beatmap.mods.has(osuBase.ModAutopilot)) {
             attributes.aimDifficulty = 0;
             attributes.flashlightDifficulty *= 0.3;
             attributes.visualDifficulty *= 0.8;
@@ -1855,7 +1854,7 @@ class DroidDifficultyCalculator extends DifficultyCalculator {
             attributes.starRating = 0;
         }
         let greatWindow;
-        if (attributes.mods.some((m) => m instanceof osuBase.ModPrecise)) {
+        if (attributes.mods.has(osuBase.ModPrecise)) {
             greatWindow = new osuBase.PreciseDroidHitWindow(beatmap.difficulty.od)
                 .greatWindow;
         }
@@ -1883,11 +1882,11 @@ class DroidDifficultyCalculator extends DifficultyCalculator {
     createSkills(beatmap) {
         const { mods } = beatmap;
         const skills = [];
-        if (!mods.some((m) => m instanceof osuBase.ModAutopilot)) {
+        if (!mods.has(osuBase.ModAutopilot)) {
             skills.push(new DroidAim(mods, true));
             skills.push(new DroidAim(mods, false));
         }
-        if (!mods.some((m) => m instanceof osuBase.ModRelax)) {
+        if (!mods.has(osuBase.ModRelax)) {
             // Tap and visual skills depend on rhythm skill, so we put it first
             skills.push(new DroidRhythm(mods));
             skills.push(new DroidTap(mods, true));
@@ -1895,7 +1894,7 @@ class DroidDifficultyCalculator extends DifficultyCalculator {
             skills.push(new DroidVisual(mods, true));
             skills.push(new DroidVisual(mods, false));
         }
-        if (mods.some((m) => m instanceof osuBase.ModFlashlight)) {
+        if (mods.has(osuBase.ModFlashlight)) {
             skills.push(new DroidFlashlight(mods, true));
             skills.push(new DroidFlashlight(mods, false));
         }
@@ -2165,15 +2164,15 @@ class PerformanceCalculator {
             });
         }
         this.effectiveMissCount = this.calculateEffectiveMissCount(combo, maxCombo);
-        if (this.mods.some((m) => m instanceof osuBase.ModNoFail)) {
+        if (this.mods.has(osuBase.ModNoFail)) {
             this.finalMultiplier *= Math.max(0.9, 1 - 0.02 * this.effectiveMissCount);
         }
-        if (this.mods.some((m) => m instanceof osuBase.ModSpunOut)) {
+        if (this.mods.has(osuBase.ModSpunOut)) {
             this.finalMultiplier *=
                 1 -
                     Math.pow(this.difficultyAttributes.spinnerCount / this.totalHits, 0.85);
         }
-        if (this.mods.some((m) => m instanceof osuBase.ModRelax)) {
+        if (this.mods.has(osuBase.ModRelax)) {
             // Graph: https://www.desmos.com/calculator/bc9eybdthb
             // We use OD13.3 as maximum since it's the value at which great hit window becomes 0.
             const n100Multiplier = Math.max(0, this.difficultyAttributes.overallDifficulty > 0
@@ -2514,12 +2513,11 @@ class DroidPerformanceCalculator extends PerformanceCalculator {
      * Calculates the accuracy performance value of the beatmap.
      */
     calculateAccuracyValue() {
-        if (this.mods.some((m) => m instanceof osuBase.ModRelax) ||
-            this.totalSuccessfulHits === 0) {
+        if (this.mods.has(osuBase.ModRelax) || this.totalSuccessfulHits === 0) {
             return 0;
         }
         let accuracyValue = 650 * Math.exp(-0.1 * this._deviation);
-        const ncircles = this.mods.some((m) => m instanceof osuBase.ModScoreV2)
+        const ncircles = this.mods.has(osuBase.ModScoreV2)
             ? this.totalHits - this.difficultyAttributes.spinnerCount
             : this.difficultyAttributes.hitCircleCount;
         // Bonus for many hitcircles - it's harder to keep good accuracy up for longer.
@@ -2531,7 +2529,7 @@ class DroidPerformanceCalculator extends PerformanceCalculator {
                     Math.exp(-(this.difficultyAttributes.rhythmDifficulty - 1) / 2));
         // Penalize accuracy pp after the first miss.
         accuracyValue *= Math.pow(0.97, Math.max(0, this.effectiveMissCount - 1));
-        if (this.mods.some((m) => m instanceof osuBase.ModFlashlight)) {
+        if (this.mods.has(osuBase.ModFlashlight)) {
             accuracyValue *= 1.02;
         }
         return accuracyValue;
@@ -2540,7 +2538,7 @@ class DroidPerformanceCalculator extends PerformanceCalculator {
      * Calculates the flashlight performance value of the beatmap.
      */
     calculateFlashlightValue() {
-        if (!this.mods.some((m) => m instanceof osuBase.ModFlashlight)) {
+        if (!this.mods.has(osuBase.ModFlashlight)) {
             return 0;
         }
         let flashlightValue = Math.pow(this.difficultyAttributes.flashlightDifficulty, 1.6) * 25;
@@ -2763,7 +2761,7 @@ class DroidPerformanceCalculator extends PerformanceCalculator {
     }
     getConvertedHitWindow() {
         const hitWindow300 = new osuBase.OsuHitWindow(this.difficultyAttributes.overallDifficulty).greatWindow;
-        if (this.mods.some((m) => m instanceof osuBase.ModPrecise)) {
+        if (this.mods.has(osuBase.ModPrecise)) {
             return new osuBase.PreciseDroidHitWindow(osuBase.PreciseDroidHitWindow.greatWindowToOD(hitWindow300 * this.difficultyAttributes.clockRate));
         }
         else {
@@ -2786,37 +2784,6 @@ class DroidPerformanceCalculator extends PerformanceCalculator {
     }
 }
 
-/**
- * Used to processes strain values of difficulty hitobjects, keep track of strain levels caused by the processed objects
- * and to calculate a final difficulty value representing the difficulty of hitting all the processed objects.
- */
-class OsuSkill extends StrainSkill {
-    difficultyValue() {
-        const strains = this.strainPeaks.slice().sort((a, b) => b - a);
-        if (this.reducedSectionCount > 0) {
-            // We are reducing the highest strains first to account for extreme difficulty spikes.
-            for (let i = 0; i < Math.min(strains.length, this.reducedSectionCount); ++i) {
-                const scale = Math.log10(osuBase.Interpolation.lerp(1, 10, osuBase.MathUtils.clamp(i / this.reducedSectionCount, 0, 1)));
-                strains[i] *= osuBase.Interpolation.lerp(this.reducedSectionBaseline, 1, scale);
-            }
-            strains.sort((a, b) => b - a);
-        }
-        // Difficulty is the weighted sum of the highest strains from every section.
-        // We're sorting from highest to lowest strain.
-        this.difficulty = 0;
-        let weight = 1;
-        for (const strain of strains) {
-            const addition = strain * weight;
-            if (this.difficulty + addition === this.difficulty) {
-                break;
-            }
-            this.difficulty += addition;
-            weight *= this.decayWeight;
-        }
-        return this.difficulty;
-    }
-}
-
 /**
  * Represents an osu!standard hit object with difficulty calculation values.
  */
@@ -2983,6 +2950,37 @@ OsuAimEvaluator.sliderMultiplier = 1.35;
 OsuAimEvaluator.velocityChangeMultiplier = 0.75;
 OsuAimEvaluator.wiggleMultiplier = 1.02;
 
+/**
+ * Used to processes strain values of difficulty hitobjects, keep track of strain levels caused by the processed objects
+ * and to calculate a final difficulty value representing the difficulty of hitting all the processed objects.
+ */
+class OsuSkill extends StrainSkill {
+    difficultyValue() {
+        const strains = this.strainPeaks.slice().sort((a, b) => b - a);
+        if (this.reducedSectionCount > 0) {
+            // We are reducing the highest strains first to account for extreme difficulty spikes.
+            for (let i = 0; i < Math.min(strains.length, this.reducedSectionCount); ++i) {
+                const scale = Math.log10(osuBase.Interpolation.lerp(1, 10, osuBase.MathUtils.clamp(i / this.reducedSectionCount, 0, 1)));
+                strains[i] *= osuBase.Interpolation.lerp(this.reducedSectionBaseline, 1, scale);
+            }
+            strains.sort((a, b) => b - a);
+        }
+        // Difficulty is the weighted sum of the highest strains from every section.
+        // We're sorting from highest to lowest strain.
+        this.difficulty = 0;
+        let weight = 1;
+        for (const strain of strains) {
+            const addition = strain * weight;
+            if (this.difficulty + addition === this.difficulty) {
+                break;
+            }
+            this.difficulty += addition;
+            weight *= this.decayWeight;
+        }
+        return this.difficulty;
+    }
+}
+
 /**
  * Represents the skill required to correctly aim at every object in the map with a uniform CircleSize and normalized distances.
  */
@@ -3124,7 +3122,7 @@ class OsuFlashlightEvaluator {
         }
         result = Math.pow(smallDistNerf * result, 2);
         // Additional bonus for Hidden due to there being no approach circles.
-        if (mods.some((m) => m instanceof osuBase.ModHidden)) {
+        if (mods.has(osuBase.ModHidden)) {
             result *= 1 + this.hiddenBonus;
         }
         // Nerf patterns with repeated angles.
@@ -3373,7 +3371,7 @@ class OsuSpeedEvaluator {
         // Max distance bonus is 1 * `distance_multiplier` at single_spacing_threshold
         let distanceBonus = Math.pow(distance / this.SINGLE_SPACING_THRESHOLD, 3.95) *
             this.DISTANCE_MULTIPLIER;
-        if (mods.some((m) => m instanceof osuBase.ModAutopilot)) {
+        if (mods.has(osuBase.ModAutopilot)) {
             distanceBonus = 0;
         }
         // Base difficulty with all bonuses
@@ -3463,7 +3461,7 @@ class OsuDifficultyCalculator extends DifficultyCalculator {
     }
     createDifficultyAttributes(beatmap, skills) {
         const attributes = new OsuDifficultyAttributes();
-        attributes.mods = beatmap.mods.slice();
+        attributes.mods = beatmap.mods;
         attributes.maxCombo = beatmap.maxCombo;
         attributes.clockRate = beatmap.speedMultiplier;
         attributes.hitCircleCount = beatmap.hitObjects.circles;
@@ -3472,12 +3470,12 @@ class OsuDifficultyCalculator extends DifficultyCalculator {
         this.populateAimAttributes(attributes, skills);
         this.populateSpeedAttributes(attributes, skills);
         this.populateFlashlightAttributes(attributes, skills);
-        if (attributes.mods.some((m) => m instanceof osuBase.ModRelax)) {
+        if (attributes.mods.has(osuBase.ModRelax)) {
             attributes.aimDifficulty *= 0.9;
             attributes.speedDifficulty = 0;
             attributes.flashlightDifficulty *= 0.7;
         }
-        else if (attributes.mods.some((m) => m instanceof osuBase.ModAutopilot)) {
+        else if (attributes.mods.has(osuBase.ModAutopilot)) {
             attributes.aimDifficulty = 0;
             attributes.speedDifficulty *= 0.5;
             attributes.flashlightDifficulty *= 0.4;
@@ -3524,14 +3522,14 @@ class OsuDifficultyCalculator extends DifficultyCalculator {
     createSkills(beatmap) {
         const { mods } = beatmap;
         const skills = [];
-        if (!mods.some((m) => m instanceof osuBase.ModAutopilot)) {
+        if (!mods.has(osuBase.ModAutopilot)) {
             skills.push(new OsuAim(mods, true));
             skills.push(new OsuAim(mods, false));
         }
-        if (!mods.some((m) => m instanceof osuBase.ModRelax)) {
+        if (!mods.has(osuBase.ModRelax)) {
             skills.push(new OsuSpeed(mods));
         }
-        if (mods.some((m) => m instanceof osuBase.ModFlashlight)) {
+        if (mods.has(osuBase.ModFlashlight)) {
             skills.push(new OsuFlashlight(mods));
         }
         return skills;
@@ -3632,7 +3630,7 @@ class OsuPerformanceCalculator extends PerformanceCalculator {
      * Calculates the aim performance value of the beatmap.
      */
     calculateAimValue() {
-        if (this.mods.some((m) => m instanceof osuBase.ModAutopilot)) {
+        if (this.mods.has(osuBase.ModAutopilot)) {
             return 0;
         }
         let aimValue = this.baseValue(this.difficultyAttributes.aimDifficulty);
@@ -3652,7 +3650,7 @@ class OsuPerformanceCalculator extends PerformanceCalculator {
         }
         aimValue *= this.calculateStrainBasedMissPenalty(this.difficultyAttributes.aimDifficultStrainCount);
         const calculatedAR = this.difficultyAttributes.approachRate;
-        if (!this.mods.some((m) => m instanceof osuBase.ModRelax)) {
+        if (!this.mods.has(osuBase.ModRelax)) {
             // AR scaling
             let arFactor = 0;
             if (calculatedAR > 10.33) {
@@ -3665,7 +3663,7 @@ class OsuPerformanceCalculator extends PerformanceCalculator {
             aimValue *= 1 + arFactor * lengthBonus;
         }
         // We want to give more reward for lower AR when it comes to aim and HD. This nerfs high AR and buffs lower AR.
-        if (this.mods.some((m) => m instanceof osuBase.ModHidden || m instanceof osuBase.ModTraceable)) {
+        if (this.mods.has(osuBase.ModHidden) || this.mods.has(osuBase.ModTraceable)) {
             aimValue *= 1 + 0.04 * (12 - calculatedAR);
         }
         // Scale the aim value with slider factor to nerf very likely dropped sliderends.
@@ -3681,7 +3679,7 @@ class OsuPerformanceCalculator extends PerformanceCalculator {
      * Calculates the speed performance value of the beatmap.
      */
     calculateSpeedValue() {
-        if (this.mods.some((m) => m instanceof osuBase.ModRelax) ||
+        if (this.mods.has(osuBase.ModRelax) ||
             this.speedDeviation === Number.POSITIVE_INFINITY) {
             return 0;
         }
@@ -3695,12 +3693,11 @@ class OsuPerformanceCalculator extends PerformanceCalculator {
         speedValue *= this.calculateStrainBasedMissPenalty(this.difficultyAttributes.speedDifficultStrainCount);
         // AR scaling
         const calculatedAR = this.difficultyAttributes.approachRate;
-        if (calculatedAR > 10.33 &&
-            !this.mods.some((m) => m instanceof osuBase.ModAutopilot)) {
+        if (calculatedAR > 10.33 && !this.mods.has(osuBase.ModAutopilot)) {
             // Buff for longer maps with high AR.
             speedValue *= 1 + 0.3 * (calculatedAR - 10.33) * lengthBonus;
         }
-        if (this.mods.some((m) => m instanceof osuBase.ModHidden || m instanceof osuBase.ModTraceable)) {
+        if (this.mods.has(osuBase.ModHidden) || this.mods.has(osuBase.ModTraceable)) {
             speedValue *= 1 + 0.04 * (12 - calculatedAR);
         }
         // Calculate accuracy assuming the worst case scenario.
@@ -3732,10 +3729,10 @@ class OsuPerformanceCalculator extends PerformanceCalculator {
      * Calculates the accuracy performance value of the beatmap.
      */
     calculateAccuracyValue() {
-        if (this.mods.some((m) => m instanceof osuBase.ModRelax)) {
+        if (this.mods.has(osuBase.ModRelax)) {
             return 0;
         }
-        const ncircles = this.mods.some((m) => m instanceof osuBase.ModScoreV2)
+        const ncircles = this.mods.has(osuBase.ModScoreV2)
             ? this.totalHits - this.difficultyAttributes.spinnerCount
             : this.difficultyAttributes.hitCircleCount;
         if (ncircles === 0) {
@@ -3750,10 +3747,10 @@ class OsuPerformanceCalculator extends PerformanceCalculator {
             2.83;
         // Bonus for many hitcircles - it's harder to keep good accuracy up for longer
         accuracyValue *= Math.min(1.15, Math.pow(ncircles / 1000, 0.3));
-        if (this.mods.some((m) => m instanceof osuBase.ModHidden || m instanceof osuBase.ModTraceable)) {
+        if (this.mods.has(osuBase.ModHidden) || this.mods.has(osuBase.ModTraceable)) {
             accuracyValue *= 1.08;
         }
-        if (this.mods.some((m) => m instanceof osuBase.ModFlashlight)) {
+        if (this.mods.has(osuBase.ModFlashlight)) {
             accuracyValue *= 1.02;
         }
         return accuracyValue;
@@ -3762,7 +3759,7 @@ class OsuPerformanceCalculator extends PerformanceCalculator {
      * Calculates the flashlight performance value of the beatmap.
      */
     calculateFlashlightValue() {
-        if (!this.mods.some((m) => m instanceof osuBase.ModFlashlight)) {
+        if (!this.mods.has(osuBase.ModFlashlight)) {
             return 0;
         }
         let flashlightValue = Math.pow(this.difficultyAttributes.flashlightDifficulty, 2) * 25;

package/package.json

@@ -1,6 +1,6 @@
 {
     "name": "@rian8337/osu-difficulty-calculator",
-    "version": "4.0.0-beta.56",
+    "version": "4.0.0-beta.58",
     "description": "A module for calculating osu!standard beatmap difficulty and performance value with respect to the current difficulty and performance algorithm.",
     "keywords": [
         "osu",
@@ -33,10 +33,10 @@
         "url": "https://github.com/Rian8337/osu-droid-module/issues"
     },
     "dependencies": {
-        "@rian8337/osu-base": "^4.0.0-beta.56"
+        "@rian8337/osu-base": "^4.0.0-beta.58"
     },
     "publishConfig": {
         "access": "public"
     },
-    "gitHead": "330ca82968253d60fd3cb8ed0d769718028a8688"
+    "gitHead": "4a5f36a02a668f15fa22b558eeeeb13237105212"
 }

package/typings/index.d.ts

@@ -1,4 +1,4 @@
-import { Mod, SerializedMod, PlaceableHitObject, Modes, PlayableBeatmap, Beatmap, DroidPlayableBeatmap, Accuracy, OsuPlayableBeatmap } from '@rian8337/osu-base';
+import { ModMap, SerializedMod, PlaceableHitObject, Modes, PlayableBeatmap, Mod, Beatmap, DroidPlayableBeatmap, Accuracy, OsuPlayableBeatmap } from '@rian8337/osu-base';
 
 /**
  * Holds data that can be used to calculate performance points.
@@ -7,7 +7,7 @@ interface IDifficultyAttributes {
     /**
      * The mods which were applied to the beatmap.
      */
-    mods: Mod[];
+    mods: ModMap;
     /**
      * The combined star rating of all skills.
      */
@@ -73,7 +73,7 @@ interface IDifficultyAttributes {
 /**
  * Represents difficulty attributes that can be cached.
  */
-type CacheableDifficultyAttributes<T extends IDifficultyAttributes> = Omit<T, "mods"> & {
+type CacheableDifficultyAttributes<T extends IDifficultyAttributes> = Omit<T, "mods" | "toCacheableAttributes"> & {
     /**
      * The mods which were applied to the beatmap.
      */
@@ -84,7 +84,7 @@ type CacheableDifficultyAttributes<T extends IDifficultyAttributes> = Omit<T, "m
  * Holds data that can be used to calculate performance points.
  */
 declare abstract class DifficultyAttributes implements IDifficultyAttributes {
-    mods: Mod[];
+    mods: ModMap;
     starRating: number;
     maxCombo: number;
     aimDifficulty: number;
@@ -104,7 +104,7 @@ declare abstract class DifficultyAttributes implements IDifficultyAttributes {
      *
      * @returns The cacheable attributes.
      */
-    toCacheableAttributes(): CacheableDifficultyAttributes<IDifficultyAttributes>;
+    toCacheableAttributes(): CacheableDifficultyAttributes<this>;
     /**
      * Returns a string representation of the difficulty attributes.
      */
@@ -262,7 +262,7 @@ declare abstract class DifficultyHitObject {
      * @param mods The mods used.
      * @returns The opacity of the hitobject at the given time.
      */
-    opacityAt(time: number, mods: readonly Mod[]): number;
+    opacityAt(time: number, mods: ModMap): number;
     /**
      * How possible is it to doubletap this object together with the next one and get perfect
      * judgement in range from 0 to 1.
@@ -285,8 +285,8 @@ declare abstract class Skill {
     /**
      * The mods that this skill processes.
      */
-    protected readonly mods: readonly Mod[];
-    constructor(mods: readonly Mod[]);
+    protected readonly mods: ModMap;
+    constructor(mods: ModMap);
     /**
      * Processes a hitobject.
      *
@@ -436,7 +436,7 @@ declare abstract class DifficultyCalculator<TBeatmap extends PlayableBeatmap, TH
      * @param mods The `Mod`s to apply to the beatmap. Defaults to No Mod.
      * @returns A `DifficultyAttributes` object describing the difficulty of the `Beatmap`.
      */
-    calculate(beatmap: Beatmap, mods?: Mod[]): TAttributes;
+    calculate(beatmap: Beatmap, mods?: ModMap): TAttributes;
     /**
      * Obtains the strain peaks of a `PlayableBeatmap`.
      *
@@ -451,7 +451,7 @@ declare abstract class DifficultyCalculator<TBeatmap extends PlayableBeatmap, TH
      * @param mods The `Mod`s to apply to the beatmap. Defaults to No Mod.
      * @returns The strain peaks of the `Beatmap`.
      */
-    calculateStrainPeaks(beatmap: Beatmap, mods: Mod[]): StrainPeaks;
+    calculateStrainPeaks(beatmap: Beatmap, mods?: ModMap): StrainPeaks;
     /**
      * Creates the `Skill`s to calculate the difficulty of a `PlayableBeatmap`.
      *
@@ -488,7 +488,7 @@ declare abstract class DifficultyCalculator<TBeatmap extends PlayableBeatmap, TH
      * @param mods The `Mod`s to apply to the `Beatmap`.
      * @returns The `PlayableBeatmap`.
      */
-    protected abstract createPlayableBeatmap(beatmap: Beatmap, mods: Mod[]): TBeatmap;
+    protected abstract createPlayableBeatmap(beatmap: Beatmap, mods?: ModMap): TBeatmap;
     /**
      * Calculates the base rating of a `Skill`.
      *
@@ -524,27 +524,6 @@ interface DifficultSlider {
     readonly difficultyRating: number;
 }
 
-/**
- * Used to processes strain values of difficulty hitobjects, keep track of strain levels caused by the processed objects
- * and to calculate a final difficulty value representing the difficulty of hitting all the processed objects.
- */
-declare abstract class DroidSkill extends StrainSkill {
-    /**
-     * The bonus multiplier that is given for a sequence of notes of equal difficulty.
-     */
-    protected abstract readonly starsPerDouble: number;
-    process(current: DifficultyHitObject): void;
-    difficultyValue(): number;
-    /**
-     * Gets the strain of a hitobject.
-     *
-     * @param current The hitobject to get the strain from.
-     * @returns The strain of the hitobject.
-     */
-    protected abstract getObjectStrain(current: DifficultyHitObject): number;
-    protected calculateCurrentSectionStart(current: DifficultyHitObject): number;
-}
-
 /**
  * Represents an osu!droid hit object with difficulty calculation values.
  */
@@ -608,7 +587,7 @@ declare class DroidDifficultyHitObject extends DifficultyHitObject {
      */
     constructor(object: PlaceableHitObject, lastObject: PlaceableHitObject | null, lastLastObject: PlaceableHitObject | null, difficultyHitObjects: readonly DifficultyHitObject[], clockRate: number, index: number);
     computeProperties(clockRate: number, hitObjects: readonly PlaceableHitObject[]): void;
-    opacityAt(time: number, mods: readonly Mod[]): number;
+    opacityAt(time: number, mods: ModMap): number;
     previous(backwardsIndex: number): this | null;
     next(forwardsIndex: number): this | null;
     /**
@@ -628,6 +607,27 @@ declare class DroidDifficultyHitObject extends DifficultyHitObject {
     private applyToOverlappingFactor;
 }
 
+/**
+ * Used to processes strain values of difficulty hitobjects, keep track of strain levels caused by the processed objects
+ * and to calculate a final difficulty value representing the difficulty of hitting all the processed objects.
+ */
+declare abstract class DroidSkill extends StrainSkill {
+    /**
+     * The bonus multiplier that is given for a sequence of notes of equal difficulty.
+     */
+    protected abstract readonly starsPerDouble: number;
+    process(current: DifficultyHitObject): void;
+    difficultyValue(): number;
+    /**
+     * Gets the strain of a hitobject.
+     *
+     * @param current The hitobject to get the strain from.
+     * @returns The strain of the hitobject.
+     */
+    protected abstract getObjectStrain(current: DifficultyHitObject): number;
+    protected calculateCurrentSectionStart(current: DifficultyHitObject): number;
+}
+
 /**
  * Represents the skill required to correctly aim at every object in the map with a uniform CircleSize and normalized distances.
  */
@@ -640,7 +640,7 @@ declare class DroidAim extends DroidSkill {
     private currentAimStrain;
     private readonly sliderStrains;
     readonly withSliders: boolean;
-    constructor(mods: readonly Mod[], withSliders: boolean);
+    constructor(mods: ModMap, withSliders: boolean);
     /**
      * Obtains the amount of sliders that are considered difficult in terms of relative strain.
      */
@@ -834,7 +834,7 @@ declare class DroidDifficultyCalculator extends DifficultyCalculator<DroidPlayab
     constructor();
     retainDifficultyAdjustmentMods(mods: Mod[]): Mod[];
     protected createDifficultyAttributes(beatmap: DroidPlayableBeatmap, skills: Skill[], objects: DroidDifficultyHitObject[]): ExtendedDroidDifficultyAttributes;
-    protected createPlayableBeatmap(beatmap: Beatmap, mods: Mod[]): DroidPlayableBeatmap;
+    protected createPlayableBeatmap(beatmap: Beatmap, mods?: ModMap): DroidPlayableBeatmap;
     protected createDifficultyHitObjects(beatmap: DroidPlayableBeatmap): DroidDifficultyHitObject[];
     protected createSkills(beatmap: DroidPlayableBeatmap): DroidSkill[];
     protected createStrainPeakSkills(beatmap: DroidPlayableBeatmap): StrainSkill[];
@@ -856,7 +856,7 @@ declare class DroidFlashlight extends DroidSkill {
     private readonly skillMultiplier;
     private currentFlashlightStrain;
     readonly withSliders: boolean;
-    constructor(mods: readonly Mod[], withSliders: boolean);
+    constructor(mods: ModMap, withSliders: boolean);
     protected strainValueAt(current: DroidDifficultyHitObject): number;
     protected calculateInitialStrain(time: number, current: DifficultyHitObject): number;
     protected getObjectStrain(): number;
@@ -888,7 +888,7 @@ declare abstract class DroidFlashlightEvaluator {
      * @param mods The mods used.
      * @param withSliders Whether to take slider difficulty into account.
      */
-    static evaluateDifficultyOf(current: DroidDifficultyHitObject, mods: readonly Mod[], withSliders: boolean): number;
+    static evaluateDifficultyOf(current: DroidDifficultyHitObject, mods: ModMap, withSliders: boolean): number;
 }
 
 /**
@@ -944,7 +944,7 @@ declare abstract class PerformanceCalculator<T extends IDifficultyAttributes> {
     /**
      * The mods that were used.
      */
-    protected readonly mods: Mod[];
+    protected readonly mods: ModMap;
     /**
      * The global multiplier to be applied to the final performance value.
      *
@@ -1199,7 +1199,7 @@ declare class DroidRhythm extends DroidSkill {
     private readonly useSliderAccuracy;
     private currentRhythmStrain;
     private currentRhythmMultiplier;
-    constructor(mods: readonly Mod[]);
+    constructor(mods: ModMap);
     protected strainValueAt(current: DroidDifficultyHitObject): number;
     protected calculateInitialStrain(time: number, current: DroidDifficultyHitObject): number;
     protected getObjectStrain(): number;
@@ -1242,7 +1242,7 @@ declare class DroidTap extends DroidSkill {
     get objectDeltaTimes(): readonly number[];
     readonly considerCheesability: boolean;
     private readonly strainTimeCap?;
-    constructor(mods: readonly Mod[], considerCheesability: boolean, strainTimeCap?: number);
+    constructor(mods: ModMap, considerCheesability: boolean, strainTimeCap?: number);
     /**
      * The amount of notes that are relevant to the difficulty.
      */
@@ -1293,7 +1293,7 @@ declare class DroidVisual extends DroidSkill {
     private currentRhythmMultiplier;
     private readonly skillMultiplier;
     readonly withSliders: boolean;
-    constructor(mods: readonly Mod[], withSliders: boolean);
+    constructor(mods: ModMap, withSliders: boolean);
     protected strainValueAt(current: DroidDifficultyHitObject): number;
     protected calculateInitialStrain(time: number, current: DroidDifficultyHitObject): number;
     protected getObjectStrain(): number;
@@ -1319,7 +1319,7 @@ declare abstract class DroidVisualEvaluator {
      * @param mods The mods used.
      * @param withSliders Whether to take slider difficulty into account.
      */
-    static evaluateDifficultyOf(current: DroidDifficultyHitObject, mods: readonly Mod[], withSliders: boolean): number;
+    static evaluateDifficultyOf(current: DroidDifficultyHitObject, mods: ModMap, withSliders: boolean): number;
 }
 
 /**
@@ -1342,18 +1342,6 @@ interface IOsuDifficultyAttributes extends IDifficultyAttributes {
     speedDifficultStrainCount: number;
 }
 
-/**
- * Used to processes strain values of difficulty hitobjects, keep track of strain levels caused by the processed objects
- * and to calculate a final difficulty value representing the difficulty of hitting all the processed objects.
- */
-declare abstract class OsuSkill extends StrainSkill {
-    /**
-     * The weight by which each strain value decays.
-     */
-    protected abstract readonly decayWeight: number;
-    difficultyValue(): number;
-}
-
 /**
  * Represents an osu!standard hit object with difficulty calculation values.
  */
@@ -1371,6 +1359,18 @@ declare class OsuDifficultyHitObject extends DifficultyHitObject {
     protected get scalingFactor(): number;
 }
 
+/**
+ * Used to processes strain values of difficulty hitobjects, keep track of strain levels caused by the processed objects
+ * and to calculate a final difficulty value representing the difficulty of hitting all the processed objects.
+ */
+declare abstract class OsuSkill extends StrainSkill {
+    /**
+     * The weight by which each strain value decays.
+     */
+    protected abstract readonly decayWeight: number;
+    difficultyValue(): number;
+}
+
 /**
  * Represents the skill required to correctly aim at every object in the map with a uniform CircleSize and normalized distances.
  */
@@ -1383,7 +1383,7 @@ declare class OsuAim extends OsuSkill {
     private readonly skillMultiplier;
     private readonly sliderStrains;
     readonly withSliders: boolean;
-    constructor(mods: readonly Mod[], withSliders: boolean);
+    constructor(mods: ModMap, withSliders: boolean);
     /**
      * Obtains the amount of sliders that are considered difficult in terms of relative strain.
      */
@@ -1440,7 +1440,7 @@ declare class OsuDifficultyCalculator extends DifficultyCalculator<OsuPlayableBe
     constructor();
     retainDifficultyAdjustmentMods(mods: Mod[]): Mod[];
     protected createDifficultyAttributes(beatmap: OsuPlayableBeatmap, skills: Skill[]): OsuDifficultyAttributes;
-    protected createPlayableBeatmap(beatmap: Beatmap, mods: Mod[]): OsuPlayableBeatmap;
+    protected createPlayableBeatmap(beatmap: Beatmap, mods?: ModMap): OsuPlayableBeatmap;
     protected createDifficultyHitObjects(beatmap: OsuPlayableBeatmap): OsuDifficultyHitObject[];
     protected createSkills(beatmap: OsuPlayableBeatmap): OsuSkill[];
     protected createStrainPeakSkills(beatmap: OsuPlayableBeatmap): StrainSkill[];
@@ -1486,7 +1486,7 @@ declare abstract class OsuFlashlightEvaluator {
      * @param current The current object.
      * @param mods The mods used.
      */
-    static evaluateDifficultyOf(current: OsuDifficultyHitObject, mods: readonly Mod[]): number;
+    static evaluateDifficultyOf(current: OsuDifficultyHitObject, mods: ModMap): number;
 }
 
 /**
@@ -1622,7 +1622,7 @@ declare abstract class OsuSpeedEvaluator {
      * @param current The current object.
      * @param mods The mods applied.
      */
-    static evaluateDifficultyOf(current: OsuDifficultyHitObject, mods: readonly Mod[]): number;
+    static evaluateDifficultyOf(current: OsuDifficultyHitObject, mods: ModMap): number;
 }
 
 export { type CacheableDifficultyAttributes, type DifficultSlider, DifficultyAttributes, DifficultyCalculator, DifficultyHitObject, DroidAim, DroidAimEvaluator, DroidDifficultyAttributes, DroidDifficultyCalculator, DroidDifficultyHitObject, DroidFlashlight, DroidFlashlightEvaluator, DroidPerformanceCalculator, DroidRhythm, DroidRhythmEvaluator, DroidTap, DroidTapEvaluator, DroidVisual, DroidVisualEvaluator, ExtendedDroidDifficultyAttributes, type HighStrainSection, type IDifficultyAttributes, type IDroidDifficultyAttributes, type IExtendedDroidDifficultyAttributes, type IOsuDifficultyAttributes, OsuAim, OsuAimEvaluator, OsuDifficultyAttributes, OsuDifficultyCalculator, OsuDifficultyHitObject, OsuFlashlight, OsuFlashlightEvaluator, OsuPerformanceCalculator, OsuRhythmEvaluator, OsuSpeed, OsuSpeedEvaluator, type PerformanceCalculationOptions, PerformanceCalculator, type StrainPeaks };