@rian8337/osu-base 2.1.0 → 2.2.0

package/dist/index.js

@@ -1299,12 +1299,21 @@ class DifficultyControlPoint extends ControlPoint {
      * The slider speed multiplier of the control point.
      */
     speedMultiplier;
+    /**
+     * Whether or not slider ticks should be generated at this control point.
+     *
+     * This exists for backwards compatibility with maps that abuse NaN slider velocity behavior on osu!stable (e.g. /b/2628991).
+     */
+    generateTicks;
+    // Generate ticks can be made required in 3.0.
     constructor(values) {
         super(values);
         this.speedMultiplier = values.speedMultiplier;
+        this.generateTicks = values.generateTicks ?? true;
     }
     isRedundant(existing) {
-        return this.speedMultiplier === existing.speedMultiplier;
+        return (this.speedMultiplier === existing.speedMultiplier &&
+            this.generateTicks === existing.generateTicks);
     }
     toString() {
         return ("{ time: " +
@@ -1716,27 +1725,42 @@ class Beatmap {
      * @param stats The statistics used for calculation.
      */
     maxDroidScore(stats) {
-        let scoreMultiplier = 1;
-        if (stats.mods.every((m) => m.droidRanked)) {
-            let scoreSpeedMultiplier = 1;
-            const speedMultiplier = stats.speedMultiplier;
-            if (speedMultiplier > 1) {
-                scoreSpeedMultiplier += (speedMultiplier - 1) * 0.24;
-            }
-            else if (speedMultiplier < 1) {
-                scoreSpeedMultiplier = Math.pow(0.3, (1 - speedMultiplier) * 4);
-            }
-            scoreMultiplier =
-                stats.mods.reduce((a, v) => a * v.scoreMultiplier, 1) *
-                    scoreSpeedMultiplier;
+        let scoreMultiplier = stats.mods.reduce((a, v) => a * v.droidScoreMultiplier, 1);
+        const { speedMultiplier } = stats;
+        if (speedMultiplier >= 1) {
+            scoreMultiplier *= 1 + (speedMultiplier - 1) * 0.24;
         }
         else {
-            scoreMultiplier = 0;
+            scoreMultiplier *= Math.pow(0.3, (1 - speedMultiplier) * 4);
         }
-        return this.maxScore(1 +
+        const difficultyMultiplier = 1 +
             this.difficulty.od / 10 +
             this.difficulty.hp / 10 +
-            (this.difficulty.cs - 3) / 4, scoreMultiplier);
+            (this.difficulty.cs - 3) / 4;
+        let combo = 0;
+        let score = 0;
+        for (const object of this.hitObjects.objects) {
+            if (!(object instanceof Slider)) {
+                score += Math.floor(300 + (300 * combo * difficultyMultiplier) / 25);
+                ++combo;
+                continue;
+            }
+            const ticksPerSpan = object.ticks;
+            const totalTicks = ticksPerSpan * (object.repeats + 1);
+            // Apply slider head.
+            score += 30;
+            ++combo;
+            // Apply slider repeats.
+            score += 30 * object.repeats;
+            combo += object.repeats;
+            // Apply slider ticks.
+            score += 10 * totalTicks;
+            combo += totalTicks;
+            // Apply slider end.
+            score += Math.floor(300 + (300 * combo * difficultyMultiplier) / 25);
+            ++combo;
+        }
+        return Math.floor(score * scoreMultiplier);
     }
     /**
      * Calculates the osu!standard maximum score of the beatmap without taking spinner bonus into account.
@@ -1746,6 +1770,7 @@ class Beatmap {
     maxOsuScore(mods = []) {
         const accumulatedDiffPoints = this.difficulty.cs + this.difficulty.hp + this.difficulty.od;
         let difficultyMultiplier = 2;
+        const scoreMultiplier = mods.reduce((a, v) => a * v.pcScoreMultiplier, 1);
         switch (true) {
             case accumulatedDiffPoints <= 5:
                 difficultyMultiplier = 2;
@@ -1763,15 +1788,6 @@ class Beatmap {
                 difficultyMultiplier = 6;
                 break;
         }
-        return this.maxScore(difficultyMultiplier, mods.reduce((a, v) => a * v.scoreMultiplier, 1));
-    }
-    /**
-     * Calculates the maximum score with a given difficulty and score multiplier.
-     *
-     * @param difficultyMultiplier The difficulty multiplier.
-     * @param scoreMultiplier The score multiplier.
-     */
-    maxScore(difficultyMultiplier, scoreMultiplier) {
         let combo = 0;
         let score = 0;
         for (const object of this.hitObjects.objects) {
@@ -1782,11 +1798,18 @@ class Beatmap {
                 ++combo;
                 continue;
             }
-            const tickCount = object.nestedHitObjects.filter((v) => v instanceof SliderTick).length;
-            // Apply sliderhead, slider repeats, and slider ticks
-            score += 30 * (object.repeats + 1) + 10 * tickCount;
-            combo += tickCount + (object.repeats + 1);
-            // Apply sliderend
+            const ticksPerSpan = object.ticks;
+            const totalTicks = ticksPerSpan * (object.repeats + 1);
+            // Apply slider head.
+            score += 30;
+            ++combo;
+            // Apply slider repeats.
+            score += 30 * object.repeats;
+            combo += object.repeats;
+            // Apply slider ticks.
+            score += 10 * totalTicks;
+            combo += totalTicks;
+            // Apply slider end.
             score += Math.floor(300 +
                 (300 * combo * difficultyMultiplier * scoreMultiplier) / 25);
             ++combo;
@@ -1995,6 +2018,7 @@ class OsuHitWindow extends HitWindow {
     }
 }
 
+// TODO: separate droid/PC mod implementations
 /**
  * Represents a mod.
  */
@@ -2010,6 +2034,8 @@ class ModDoubleTime extends Mod {
     name = "DoubleTime";
     droidRanked = true;
     pcRanked = true;
+    droidScoreMultiplier = 1.12;
+    pcScoreMultiplier = 1.12;
     bitwise = 1 << 6;
     droidString = "d";
     droidOnly = false;
@@ -2024,6 +2050,8 @@ class ModHalfTime extends Mod {
     name = "HalfTime";
     droidRanked = true;
     pcRanked = true;
+    droidScoreMultiplier = 0.3;
+    pcScoreMultiplier = 0.3;
     bitwise = 1 << 8;
     droidString = "t";
     droidOnly = false;
@@ -2038,6 +2066,8 @@ class ModNightCore extends Mod {
     name = "NightCore";
     droidRanked = true;
     pcRanked = true;
+    droidScoreMultiplier = 1.12;
+    pcScoreMultiplier = 1.12;
     bitwise = 1 << 9;
     droidString = "c";
     droidOnly = false;
@@ -2053,6 +2083,8 @@ class ModHardRock extends Mod {
     bitwise = 1 << 4;
     droidRanked = true;
     pcRanked = true;
+    droidScoreMultiplier = 1.06;
+    pcScoreMultiplier = 1.06;
     droidString = "r";
     droidOnly = false;
 }
@@ -2066,6 +2098,8 @@ class ModEasy extends Mod {
     name = "Easy";
     droidRanked = true;
     pcRanked = true;
+    droidScoreMultiplier = 0.5;
+    pcScoreMultiplier = 0.5;
     bitwise = 1 << 1;
     droidString = "e";
     droidOnly = false;
@@ -2080,6 +2114,8 @@ class ModPrecise extends Mod {
     name = "Precise";
     droidRanked = true;
     pcRanked = false;
+    droidScoreMultiplier = 1.06;
+    pcScoreMultiplier = 1.06;
     bitwise = Number.NaN;
     droidString = "s";
     droidOnly = true;
@@ -2094,6 +2130,8 @@ class ModSmallCircle extends Mod {
     name = "SmallCircle";
     droidRanked = false;
     pcRanked = false;
+    droidScoreMultiplier = 1.06;
+    pcScoreMultiplier = 1;
     bitwise = Number.NaN;
     droidString = "m";
     droidOnly = true;
@@ -2108,6 +2146,8 @@ class ModReallyEasy extends Mod {
     name = "ReallyEasy";
     droidRanked = false;
     pcRanked = false;
+    droidScoreMultiplier = 0.4;
+    pcScoreMultiplier = 0.4;
     bitwise = Number.NaN;
     droidString = "l";
     droidOnly = true;
@@ -2122,6 +2162,8 @@ class ModAuto extends Mod {
     name = "Autoplay";
     droidRanked = false;
     pcRanked = false;
+    droidScoreMultiplier = 1;
+    pcScoreMultiplier = 1;
     bitwise = 1 << 11;
     droidString = "a";
     droidOnly = false;
@@ -2136,6 +2178,8 @@ class ModAutopilot extends Mod {
     name = "Autopilot";
     droidRanked = false;
     pcRanked = false;
+    droidScoreMultiplier = 0.001;
+    pcScoreMultiplier = 0;
     bitwise = 1 << 13;
     droidString = "p";
     droidOnly = false;
@@ -2150,6 +2194,8 @@ class ModFlashlight extends Mod {
     name = "Flashlight";
     droidRanked = false;
     pcRanked = true;
+    droidScoreMultiplier = 1.12;
+    pcScoreMultiplier = 1.12;
     bitwise = 1 << 10;
     droidString = "i";
     droidOnly = false;
@@ -2167,6 +2213,8 @@ class ModHidden extends Mod {
     bitwise = 1 << 3;
     droidRanked = true;
     pcRanked = true;
+    droidScoreMultiplier = 1.06;
+    pcScoreMultiplier = 1.06;
     droidString = "h";
     droidOnly = false;
 }
@@ -2180,6 +2228,8 @@ class ModNoFail extends Mod {
     name = "NoFail";
     droidRanked = true;
     pcRanked = true;
+    droidScoreMultiplier = 0.5;
+    pcScoreMultiplier = 0.5;
     bitwise = 1 << 0;
     droidString = "n";
     droidOnly = false;
@@ -2194,6 +2244,8 @@ class ModPerfect extends Mod {
     name = "Perfect";
     droidRanked = false;
     pcRanked = true;
+    droidScoreMultiplier = 1;
+    pcScoreMultiplier = 1;
     bitwise = 1 << 14;
     droidString = "f";
     droidOnly = false;
@@ -2208,6 +2260,8 @@ class ModRelax extends Mod {
     name = "Relax";
     droidRanked = false;
     pcRanked = false;
+    droidScoreMultiplier = 0.001;
+    pcScoreMultiplier = 0;
     bitwise = 1 << 7;
     droidString = "x";
     droidOnly = false;
@@ -2222,6 +2276,8 @@ class ModScoreV2 extends Mod {
     name = "ScoreV2";
     droidRanked = false;
     pcRanked = false;
+    droidScoreMultiplier = 1;
+    pcScoreMultiplier = 1;
     bitwise = 1 << 29;
     droidString = "v";
     droidOnly = false;
@@ -2236,6 +2292,8 @@ class ModSpunOut extends Mod {
     name = "SpunOut";
     droidRanked = false;
     pcRanked = true;
+    droidScoreMultiplier = 0.9;
+    pcScoreMultiplier = 0.9;
     bitwise = 1 << 12;
     droidString = "";
     droidOnly = false;
@@ -2250,6 +2308,8 @@ class ModSuddenDeath extends Mod {
     name = "Sudden Death";
     droidRanked = false;
     pcRanked = true;
+    droidScoreMultiplier = 1;
+    pcScoreMultiplier = 1;
     bitwise = 1 << 5;
     droidString = "u";
     droidOnly = false;
@@ -2264,6 +2324,8 @@ class ModTouchDevice extends Mod {
     name = "TouchDevice";
     droidRanked = true;
     pcRanked = true;
+    droidScoreMultiplier = 1;
+    pcScoreMultiplier = 1;
     bitwise = 1 << 2;
     droidString = "";
     droidOnly = false;
@@ -3304,6 +3366,9 @@ class Decoder {
         for (let line of str.split("\n")) {
             this.currentLine = line;
             ++this.line;
+            if (this.shouldSkipLine(line)) {
+                continue;
+            }
             if (this.section !== BeatmapSection.metadata) {
                 // Comments should not be stripped from metadata lines, as the song metadata may contain "//" as valid data.
                 const index = line.indexOf("//");
@@ -3341,6 +3406,15 @@ class Decoder {
         }
         return this;
     }
+    /**
+     * Determines whether a line should be skipped.
+     *
+     * @param line The line to determine.
+     * @returns Whether the line should be skipped.
+     */
+    shouldSkipLine(line) {
+        return !line || line.trimStart().startsWith("//");
+    }
     /**
      * Internal decoder function for decoding a line.
      *
@@ -3420,29 +3494,43 @@ class SectionDecoder {
      * @param str The string to parse.
      * @param min The minimum threshold. Defaults to `-ParserConstants.MAX_PARSE_VALUE`.
      * @param max The maximum threshold. Defaults to `ParserConstants.MAX_PARSE_VALUE`.
+     * @param allowNaN Whether to allow NaN.
      * @returns The parsed integer.
      */
-    tryParseInt(str, min = -ParserConstants.MAX_PARSE_VALUE, max = ParserConstants.MAX_PARSE_VALUE) {
+    tryParseInt(str, min = -ParserConstants.MAX_PARSE_VALUE, max = ParserConstants.MAX_PARSE_VALUE, allowNaN = false) {
         const num = parseInt(str);
-        if (!this.isNumberValid(num, min, max)) {
-            throw new RangeError(`Couldn't parse ${str} into an int: value is either invalid, too low, or too high`);
+        if (num < min) {
+            throw new RangeError("Value is too low");
+        }
+        if (num > max) {
+            throw new RangeError("Value is too high");
+        }
+        if (!allowNaN && Number.isNaN(num)) {
+            throw new RangeError("Not a number");
         }
         return num;
     }
     /**
      * Attempts to parse a string into a float.
      *
-     * Throws an exception when the resulting value is invalid (such as NaN), too low, or too high.
+     * Throws an exception when the resulting value is too low or too high.
      *
      * @param str The string to parse.
      * @param min The minimum threshold. Defaults to `-ParserConstants.MAX_PARSE_VALUE`.
      * @param max The maximum threshold. Defaults to `ParserConstants.MAX_PARSE_VALUE`.
+     * @param allowNaN Whether to allow NaN.
      * @returns The parsed float.
      */
-    tryParseFloat(str, min = -ParserConstants.MAX_PARSE_VALUE, max = ParserConstants.MAX_PARSE_VALUE) {
+    tryParseFloat(str, min = -ParserConstants.MAX_PARSE_VALUE, max = ParserConstants.MAX_PARSE_VALUE, allowNaN = false) {
         const num = parseFloat(str);
-        if (!this.isNumberValid(num, min, max)) {
-            throw new RangeError(`Couldn't parse ${str} into a float: value is either invalid, too low, or too high`);
+        if (num < min) {
+            throw new RangeError("Value is too low");
+        }
+        if (num > max) {
+            throw new RangeError("Value is too high");
+        }
+        if (!allowNaN && Number.isNaN(num)) {
+            throw new RangeError("Not a number");
         }
         return num;
     }
@@ -3502,8 +3590,8 @@ class BeatmapHitObjectsDecoder extends SectionDecoder {
             }
             const repetitions = Math.max(0, this.tryParseInt(this.setPosition(s[6]), -ParserConstants.MAX_PARSE_VALUE, ParserConstants.MAX_REPETITIONS_VALUE));
             const distance = Math.max(0, this.tryParseFloat(this.setPosition(s[7])));
-            const speedMultiplierTimingPoint = this.target.controlPoints.difficulty.controlPointAt(time);
-            const msPerBeatTimingPoint = this.target.controlPoints.timing.controlPointAt(time);
+            const difficultyControlPoint = this.target.controlPoints.difficulty.controlPointAt(time);
+            const timingControlPoint = this.target.controlPoints.timing.controlPointAt(time);
             const points = [new Vector2(0, 0)];
             const pointSplit = this.setPosition(s[5]).split("|");
             let pathType = pointSplit.shift();
@@ -3573,6 +3661,23 @@ class BeatmapHitObjectsDecoder extends SectionDecoder {
             comboOffset += this.extraComboOffset;
             this.forceNewCombo = false;
             this.extraComboOffset = 0;
+            let tickDistanceMultiplier = Number.POSITIVE_INFINITY;
+            if (difficultyControlPoint.generateTicks) {
+                if (this.isNumberValid(timingControlPoint.msPerBeat, ParserConstants.MIN_MSPERBEAT_VALUE, ParserConstants.MAX_MSPERBEAT_VALUE)) {
+                    // Prior to v8, speed multipliers don't adjust for how many ticks are generated over the same distance.
+                    // This results in more (or less) ticks being generated in <v8 maps for the same time duration.
+                    //
+                    // This additional check is used in case BPM goes very low or very high.
+                    // When lazer is final, this should be revisited.
+                    tickDistanceMultiplier =
+                        this.target.formatVersion < 8
+                            ? 1 / difficultyControlPoint.speedMultiplier
+                            : 1;
+                }
+                else {
+                    tickDistanceMultiplier = 0;
+                }
+            }
             object = new Slider({
                 position: position,
                 startTime: time,
@@ -3582,20 +3687,11 @@ class BeatmapHitObjectsDecoder extends SectionDecoder {
                 nodeSamples: nodeSamples,
                 repetitions: repetitions,
                 path: path,
-                speedMultiplier: MathUtils.clamp(speedMultiplierTimingPoint.speedMultiplier, ParserConstants.MIN_SPEEDMULTIPLIER_VALUE, ParserConstants.MAX_SPEEDMULTIPLIER_VALUE),
-                msPerBeat: msPerBeatTimingPoint.msPerBeat,
+                speedMultiplier: MathUtils.clamp(difficultyControlPoint.speedMultiplier, ParserConstants.MIN_SPEEDMULTIPLIER_VALUE, ParserConstants.MAX_SPEEDMULTIPLIER_VALUE),
+                msPerBeat: timingControlPoint.msPerBeat,
                 mapSliderVelocity: this.target.difficulty.sliderMultiplier,
                 mapTickRate: this.target.difficulty.sliderTickRate,
-                // Prior to v8, speed multipliers don't adjust for how many ticks are generated over the same distance.
-                // This results in more (or less) ticks being generated in <v8 maps for the same time duration.
-                //
-                // This additional check is used in case BPM goes very low or very high.
-                // When lazer is final, this should be revisited.
-                tickDistanceMultiplier: this.isNumberValid(msPerBeatTimingPoint.msPerBeat, ParserConstants.MIN_MSPERBEAT_VALUE, ParserConstants.MAX_MSPERBEAT_VALUE)
-                    ? this.target.formatVersion < 8
-                        ? 1 / speedMultiplierTimingPoint.speedMultiplier
-                        : 1
-                    : 0,
+                tickDistanceMultiplier: tickDistanceMultiplier,
             });
         }
         else if (type & exports.objectTypes.spinner) {
@@ -4143,7 +4239,9 @@ class BeatmapControlPointsDecoder extends SectionDecoder {
             throw new Error("Ignoring malformed timing point");
         }
         const time = this.target.getOffsetTime(this.tryParseFloat(this.setPosition(s[0])));
-        const msPerBeat = this.tryParseFloat(this.setPosition(s[1]));
+        // msPerBeat is allowed to be NaN to handle an edge case in which some
+        // beatmaps use NaN slider velocity to disable slider tick generation.
+        const msPerBeat = this.tryParseFloat(this.setPosition(s[1]), undefined, undefined, true);
         let timeSignature = 4;
         if (s.length >= 3) {
             timeSignature = this.tryParseInt(this.setPosition(s[2]));
@@ -4170,7 +4268,14 @@ class BeatmapControlPointsDecoder extends SectionDecoder {
             kiaiMode = !!(effectBitFlags & EffectFlags.kiai);
             omitFirstBarSignature = !!(effectBitFlags & EffectFlags.omitFirstBarLine);
         }
-        if (msPerBeat >= 0) {
+        let timingChange = true;
+        if (s.length >= 7) {
+            timingChange = s[6] === "1";
+        }
+        if (timingChange) {
+            if (Number.isNaN(msPerBeat)) {
+                throw new Error("Beat length cannot be NaN in a timing control point");
+            }
             this.target.controlPoints.timing.add(new TimingControlPoint({
                 time: time,
                 msPerBeat: msPerBeat,
@@ -4179,7 +4284,9 @@ class BeatmapControlPointsDecoder extends SectionDecoder {
         }
         this.target.controlPoints.difficulty.add(new DifficultyControlPoint({
             time: time,
+            // If msPerBeat is NaN, speedMultiplier should still be 1 because all comparisons against NaN are false.
             speedMultiplier: msPerBeat < 0 ? 100 / -msPerBeat : 1,
+            generateTicks: !Number.isNaN(msPerBeat),
         }));
         this.target.controlPoints.effect.add(new EffectControlPoint({
             time: time,