@rian8337/osu-base 4.0.0-beta.19 → 4.0.0-beta.24

package/dist/index.js

@@ -377,6 +377,19 @@ class Vector2 {
  * Contains difficulty settings of a beatmap.
  */
 class BeatmapDifficulty {
+    /**
+     * The approach rate of the beatmap.
+     */
+    get ar() {
+        var _a;
+        return (_a = this._ar) !== null && _a !== void 0 ? _a : this.od;
+    }
+    /**
+     * The approach rate of the beatmap.
+     */
+    set ar(value) {
+        this._ar = value;
+    }
     constructor(shallowCopy) {
         /**
          * The circle size of the beatmap.
@@ -401,7 +414,7 @@ class BeatmapDifficulty {
         if (!shallowCopy) {
             return;
         }
-        this.ar = shallowCopy.ar;
+        this._ar = shallowCopy._ar;
         this.cs = shallowCopy.cs;
         this.od = shallowCopy.od;
         this.hp = shallowCopy.hp;
@@ -852,22 +865,22 @@ class OsuHitWindow extends HitWindow {
  * @returns The difficulty statistics of the beatmap.
  */
 function calculateDroidDifficultyStatistics(options) {
-    var _a, _b, _c, _d, _e, _f, _g, _h, _j, _k, _l, _m;
+    var _a, _b, _c, _d, _e, _f, _g, _h, _j, _k, _l;
     const overallSpeedMultiplier = calculateSpeedMultiplierFromMods((_a = options.mods) !== null && _a !== void 0 ? _a : [], options.oldStatistics) * ((_b = options.customSpeedMultiplier) !== null && _b !== void 0 ? _b : 1);
     const difficulty = new BeatmapDifficulty();
     difficulty.cs = (_c = options.circleSize) !== null && _c !== void 0 ? _c : difficulty.cs;
-    difficulty.ar = (_e = (_d = options.approachRate) !== null && _d !== void 0 ? _d : difficulty.ar) !== null && _e !== void 0 ? _e : difficulty.od;
-    difficulty.od = (_f = options.overallDifficulty) !== null && _f !== void 0 ? _f : difficulty.od;
-    difficulty.hp = (_g = options.healthDrain) !== null && _g !== void 0 ? _g : difficulty.hp;
-    const difficultyAdjustMod = (_h = options.mods) === null || _h === void 0 ? void 0 : _h.find((mod) => mod instanceof ModDifficultyAdjust);
-    (_j = options.mods) === null || _j === void 0 ? void 0 : _j.forEach((mod) => {
+    difficulty.ar = (_d = options.approachRate) !== null && _d !== void 0 ? _d : difficulty.ar;
+    difficulty.od = (_e = options.overallDifficulty) !== null && _e !== void 0 ? _e : difficulty.od;
+    difficulty.hp = (_f = options.healthDrain) !== null && _f !== void 0 ? _f : difficulty.hp;
+    const difficultyAdjustMod = (_g = options.mods) === null || _g === void 0 ? void 0 : _g.find((mod) => mod instanceof ModDifficultyAdjust);
+    (_h = options.mods) === null || _h === void 0 ? void 0 : _h.forEach((mod) => {
         if (mod.isApplicableToDifficulty()) {
             mod.applyToDifficulty(exports.Modes.droid, difficulty);
         }
     });
     // Special handling for difficulty adjust mod where difficulty statistics are forced.
     difficultyAdjustMod === null || difficultyAdjustMod === void 0 ? void 0 : difficultyAdjustMod.applyToDifficulty(exports.Modes.droid, difficulty);
-    (_k = options.mods) === null || _k === void 0 ? void 0 : _k.forEach((mod, _, arr) => {
+    (_j = options.mods) === null || _j === void 0 ? void 0 : _j.forEach((mod, _, arr) => {
         var _a;
         if (mod.isApplicableToDifficultyWithSettings()) {
             mod.applyToDifficultyWithSettings(exports.Modes.droid, difficulty, arr, (_a = options.customSpeedMultiplier) !== null && _a !== void 0 ? _a : 1);
@@ -887,7 +900,7 @@ function calculateDroidDifficultyStatistics(options) {
         difficulty.ar = convertApproachRateMilliseconds(approachRateMilliseconds);
     }
     if (options.overallDifficulty !== undefined) {
-        const isPrecise = (_m = (_l = options.mods) === null || _l === void 0 ? void 0 : _l.some((mod) => mod instanceof ModPrecise)) !== null && _m !== void 0 ? _m : false;
+        const isPrecise = (_l = (_k = options.mods) === null || _k === void 0 ? void 0 : _k.some((mod) => mod instanceof ModPrecise)) !== null && _l !== void 0 ? _l : false;
         let hitWindowGreat = new DroidHitWindow(difficulty.od).hitWindowFor300(isPrecise);
         if ((difficultyAdjustMod === null || difficultyAdjustMod === void 0 ? void 0 : difficultyAdjustMod.od) === undefined) {
             hitWindowGreat /= overallSpeedMultiplier;
@@ -922,23 +935,23 @@ function calculateDroidDifficultyStatistics(options) {
  * @returns The difficulty statistics of the beatmap.
  */
 function calculateOsuDifficultyStatistics(options) {
-    var _a, _b, _c, _d, _e, _f, _g, _h, _j, _k;
+    var _a, _b, _c, _d, _e, _f, _g, _h, _j;
     const overallSpeedMultiplier = calculateSpeedMultiplierFromMods((_a = options.mods) !== null && _a !== void 0 ? _a : []) *
         ((_b = options.customSpeedMultiplier) !== null && _b !== void 0 ? _b : 1);
     const difficulty = new BeatmapDifficulty();
     difficulty.cs = (_c = options.circleSize) !== null && _c !== void 0 ? _c : difficulty.cs;
-    difficulty.ar = (_e = (_d = options.approachRate) !== null && _d !== void 0 ? _d : difficulty.ar) !== null && _e !== void 0 ? _e : difficulty.od;
-    difficulty.od = (_f = options.overallDifficulty) !== null && _f !== void 0 ? _f : difficulty.od;
-    difficulty.hp = (_g = options.healthDrain) !== null && _g !== void 0 ? _g : difficulty.hp;
-    const difficultyAdjustMod = (_h = options.mods) === null || _h === void 0 ? void 0 : _h.find((mod) => mod instanceof ModDifficultyAdjust);
-    (_j = options.mods) === null || _j === void 0 ? void 0 : _j.forEach((mod) => {
+    difficulty.ar = (_d = options.approachRate) !== null && _d !== void 0 ? _d : difficulty.ar;
+    difficulty.od = (_e = options.overallDifficulty) !== null && _e !== void 0 ? _e : difficulty.od;
+    difficulty.hp = (_f = options.healthDrain) !== null && _f !== void 0 ? _f : difficulty.hp;
+    const difficultyAdjustMod = (_g = options.mods) === null || _g === void 0 ? void 0 : _g.find((mod) => mod instanceof ModDifficultyAdjust);
+    (_h = options.mods) === null || _h === void 0 ? void 0 : _h.forEach((mod) => {
         if (mod.isApplicableToDifficulty()) {
             mod.applyToDifficulty(exports.Modes.osu, difficulty);
         }
     });
     // Special handling for difficulty adjust mod where difficulty statistics are forced.
     difficultyAdjustMod === null || difficultyAdjustMod === void 0 ? void 0 : difficultyAdjustMod.applyToDifficulty(exports.Modes.osu, difficulty);
-    (_k = options.mods) === null || _k === void 0 ? void 0 : _k.forEach((mod, _, arr) => {
+    (_j = options.mods) === null || _j === void 0 ? void 0 : _j.forEach((mod, _, arr) => {
         var _a;
         if (mod.isApplicableToDifficultyWithSettings()) {
             mod.applyToDifficultyWithSettings(exports.Modes.osu, difficulty, arr, (_a = options.customSpeedMultiplier) !== null && _a !== void 0 ? _a : 1);
@@ -1127,8 +1140,7 @@ class HitObject {
      * @param mode The gamemode to apply defaults for.
      */
     applyDefaults(controlPoints, difficulty, mode) {
-        var _a;
-        this.timePreempt = convertApproachRateToMilliseconds((_a = difficulty.ar) !== null && _a !== void 0 ? _a : difficulty.od);
+        this.timePreempt = convertApproachRateToMilliseconds(difficulty.ar);
         // Preempt time can go below 450ms. Normally, this is achieved via the DT mod which uniformly speeds up all animations game wide regardless of AR.
         // This uniform speedup is hard to match 1:1, however we can at least make AR>10 (via mods) feel good by extending the upper linear function above.
         // Note that this doesn't exactly match the AR>10 visuals as they're classically known, but it feels good.
@@ -1139,8 +1151,7 @@ class HitObject {
                 const cs = calculateDroidDifficultyStatistics({
                     circleSize: difficulty.cs,
                 }).circleSize;
-                this._scale =
-                    CircleSizeCalculator.standardCSToStandardScale(cs);
+                this._scale = CircleSizeCalculator.standardCSToStandardScale(cs, true);
                 break;
             }
             case exports.Modes.osu:
@@ -5357,7 +5368,6 @@ class BeatmapDecoder extends Decoder {
         super(...arguments);
         this.finalResult = new Beatmap();
         this.decoders = {};
-        this.previousSection = BeatmapSection.general;
     }
     /**
      * @param str The string to decode.
@@ -5383,14 +5393,6 @@ class BeatmapDecoder extends Decoder {
         if (this.finalResult.formatVersion !== this.formatVersion) {
             this.finalResult.formatVersion = this.formatVersion;
         }
-        // We need to track the previous section in case AR isn't specified in the beatmap file.
-        if (this.previousSection !== this.section) {
-            if (this.previousSection === BeatmapSection.difficulty &&
-                this.finalResult.difficulty.ar === undefined) {
-                this.finalResult.difficulty.ar = this.finalResult.difficulty.od;
-            }
-            this.previousSection = this.section;
-        }
         super.decodeLine(line);
     }
     reset() {
@@ -5645,7 +5647,6 @@ class BeatmapControlPointsEncoder extends BeatmapBaseEncoder {
  */
 class BeatmapDifficultyEncoder extends BeatmapBaseEncoder {
     encodeInternal() {
-        var _a;
         if (this.encodeSections) {
             this.writeLine("[Difficulty]");
         }
@@ -5653,7 +5654,7 @@ class BeatmapDifficultyEncoder extends BeatmapBaseEncoder {
         this.writeLine(`HPDrainRate: ${difficulty.hp}`);
         this.writeLine(`CircleSize: ${difficulty.cs}`);
         this.writeLine(`OverallDifficulty: ${difficulty.od}`);
-        this.writeLine(`ApproachRate: ${(_a = difficulty.ar) !== null && _a !== void 0 ? _a : difficulty.od}`);
+        this.writeLine(`ApproachRate: ${difficulty.ar}`);
         this.writeLine(`SliderMultiplier: ${difficulty.sliderMultiplier}`);
         this.writeLine(`SliderTickRate: ${difficulty.sliderTickRate}`);
     }
@@ -7389,22 +7390,34 @@ ErrorFunction.ervInvImpGd = [
 ];
 
 /**
- * Holds interpolation methods for numbers.
+ * Holds interpolation methods for numbers and vectors.
  */
 class Interpolation {
-    /**
-     * Performs a linear interpolation.
-     *
-     * @param start The starting point of the interpolation.
-     * @param final The final point of the interpolation.
-     * @param amount The interpolation multiplier.
-     * @returns The interpolated value.
-     */
     static lerp(start, final, amount) {
-        return start + (final - start) * amount;
+        if (start instanceof Vector2 && final instanceof Vector2) {
+            return new Vector2(this.lerp(start.x, final.x, amount), this.lerp(start.y, final.y, amount));
+        }
+        else {
+            return (start +
+                (final - start) * amount);
+        }
     }
 }
 
+/**
+ * Ranking status of a beatmap.
+ */
+exports.RankedStatus = void 0;
+(function (RankedStatus) {
+    RankedStatus[RankedStatus["graveyard"] = -2] = "graveyard";
+    RankedStatus[RankedStatus["wip"] = -1] = "wip";
+    RankedStatus[RankedStatus["pending"] = 0] = "pending";
+    RankedStatus[RankedStatus["ranked"] = 1] = "ranked";
+    RankedStatus[RankedStatus["approved"] = 2] = "approved";
+    RankedStatus[RankedStatus["qualified"] = 3] = "qualified";
+    RankedStatus[RankedStatus["loved"] = 4] = "loved";
+})(exports.RankedStatus || (exports.RankedStatus = {}));
+
 /**
  * An API request builder for osu!standard.
  */
@@ -7449,7 +7462,7 @@ class MapInfo {
         /**
          * The ranking status of the beatmap.
          */
-        this.approved = 0;
+        this.approved = exports.RankedStatus.pending;
         /**
          * The ID of the beatmap.
          */
@@ -7521,7 +7534,7 @@ class MapInfo {
         /**
          * The maximum combo of the beatmap.
          */
-        this.maxCombo = 0;
+        this.maxCombo = null;
         /**
          * The circle size of the beatmap.
          */
@@ -7677,7 +7690,8 @@ class MapInfo {
         map.spinners = mapinfo.count_spinner
             ? parseInt(mapinfo.count_spinner)
             : 0;
-        map.maxCombo = parseInt(mapinfo.max_combo);
+        map.maxCombo =
+            mapinfo.max_combo !== null ? parseInt(mapinfo.max_combo) : null;
         map.cs = parseFloat(mapinfo.diff_size);
         map.ar = parseFloat(mapinfo.diff_approach);
         map.od = parseFloat(mapinfo.diff_overall);
@@ -7708,7 +7722,7 @@ class MapInfo {
      * @returns The raw API response represented by this `MapInfo`.
      */
     toAPIResponse() {
-        var _a, _b, _c, _d, _e, _f;
+        var _a, _b, _c, _d, _e, _f, _g, _h;
         const padDateNumber = (num) => num.toString().padStart(2, "0");
         const convertDate = (date) => `${date.getUTCFullYear()}-${padDateNumber(date.getUTCMonth() + 1)}-${padDateNumber(date.getUTCDate())} ${padDateNumber(date.getUTCHours())}:${padDateNumber(date.getUTCMinutes())}:${padDateNumber(date.getUTCSeconds())}`;
         return {
@@ -7749,7 +7763,7 @@ class MapInfo {
             count_normal: this.circles.toString(),
             count_slider: this.sliders.toString(),
             count_spinner: this.spinners.toString(),
-            max_combo: this.maxCombo.toString(),
+            max_combo: (_h = (_g = this.maxCombo) === null || _g === void 0 ? void 0 : _g.toString()) !== null && _h !== void 0 ? _h : null,
             storyboard: this.storyboardAvailable ? "1" : "0",
             video: this.videoAvailable ? "1" : "0",
             download_unavailable: this.downloadAvailable ? "0" : "1",
@@ -7859,9 +7873,7 @@ class ModEasy extends Mod {
             case exports.Modes.osu:
                 difficulty.cs /= 2;
         }
-        if (difficulty.ar !== undefined) {
-            difficulty.ar /= 2;
-        }
+        difficulty.ar /= 2;
         difficulty.od /= 2;
         difficulty.hp /= 2;
     }
@@ -7913,9 +7925,7 @@ class ModHardRock extends Mod {
                 difficulty.cs = this.applySetting(difficulty.cs, 1.3);
                 break;
         }
-        if (difficulty.ar !== undefined) {
-            difficulty.ar = this.applySetting(difficulty.ar);
-        }
+        difficulty.ar = this.applySetting(difficulty.ar);
         difficulty.od = this.applySetting(difficulty.od);
         difficulty.hp = this.applySetting(difficulty.hp);
     }
@@ -8008,8 +8018,7 @@ class ModReallyEasy extends Mod {
             return;
         }
         const difficultyAdjustMod = mods.find((m) => m instanceof ModDifficultyAdjust);
-        if ((difficultyAdjustMod === null || difficultyAdjustMod === void 0 ? void 0 : difficultyAdjustMod.ar) === undefined &&
-            difficulty.ar !== undefined) {
+        if ((difficultyAdjustMod === null || difficultyAdjustMod === void 0 ? void 0 : difficultyAdjustMod.ar) === undefined) {
             if (mods.some((m) => m instanceof ModEasy)) {
                 difficulty.ar *= 2;
                 difficulty.ar -= 0.5;
@@ -8357,20 +8366,6 @@ class Playfield {
  */
 Playfield.baseSize = new Vector2(512, 384);
 
-/**
- * Ranking status of a beatmap.
- */
-exports.RankedStatus = void 0;
-(function (RankedStatus) {
-    RankedStatus[RankedStatus["graveyard"] = -2] = "graveyard";
-    RankedStatus[RankedStatus["wip"] = -1] = "wip";
-    RankedStatus[RankedStatus["pending"] = 0] = "pending";
-    RankedStatus[RankedStatus["ranked"] = 1] = "ranked";
-    RankedStatus[RankedStatus["approved"] = 2] = "approved";
-    RankedStatus[RankedStatus["qualified"] = 3] = "qualified";
-    RankedStatus[RankedStatus["loved"] = 4] = "loved";
-})(exports.RankedStatus || (exports.RankedStatus = {}));
-
 dotenv.config();
 
 exports.AR0_MS = AR0_MS;

package/package.json

@@ -1,6 +1,6 @@
 {
     "name": "@rian8337/osu-base",
-    "version": "4.0.0-beta.19",
+    "version": "4.0.0-beta.24",
     "description": "Base module for all osu! related modules.",
     "keywords": [
         "osu",
@@ -42,5 +42,5 @@
     "publishConfig": {
         "access": "public"
     },
-    "gitHead": "45f7c976ba683027dc3a4d29de8bf289aadf7707"
+    "gitHead": "b567d54f6f8553aeaf56acb8a0b3741c3920b72b"
 }

package/typings/index.d.ts

@@ -158,7 +158,15 @@ declare class BeatmapDifficulty {
     /**
      * The approach rate of the beatmap.
      */
-    ar?: number;
+    private _ar?;
+    /**
+     * The approach rate of the beatmap.
+     */
+    get ar(): number;
+    /**
+     * The approach rate of the beatmap.
+     */
+    set ar(value: number);
     /**
      * The circle size of the beatmap.
      */
@@ -1970,7 +1978,6 @@ declare abstract class Decoder<R, D extends SectionDecoder<R>> {
 declare class BeatmapDecoder extends Decoder<Beatmap, SectionDecoder<Beatmap>> {
     protected finalResult: Beatmap;
     protected decoders: Partial<Record<BeatmapSection, SectionDecoder<Beatmap>>>;
-    private previousSection;
     /**
      * @param str The string to decode.
      * @param mode The mode to parse the beatmap as. Defaults to osu!standard.
@@ -3338,11 +3345,11 @@ declare enum HitSoundType {
 type If<T extends boolean, A, B = null> = T extends true ? A : T extends false ? B : A | B;
 
 /**
- * Holds interpolation methods for numbers.
+ * Holds interpolation methods for numbers and vectors.
  */
 declare abstract class Interpolation {
     /**
-     * Performs a linear interpolation.
+     * Performs a linear interpolation of numbers.
      *
      * @param start The starting point of the interpolation.
      * @param final The final point of the interpolation.
@@ -3350,6 +3357,15 @@ declare abstract class Interpolation {
      * @returns The interpolated value.
      */
     static lerp(start: number, final: number, amount: number): number;
+    /**
+     * Performs a linear interpolation of vectors.
+     *
+     * @param start The starting point of the interpolation.
+     * @param final The final point of the interpolation.
+     * @param amount The interpolation multiplier.
+     * @returns The interpolated vector.
+     */
+    static lerp(start: Vector2, final: Vector2, amount: number): Vector2;
 }
 
 /**
@@ -3400,7 +3416,7 @@ interface OsuAPIResponse {
     readonly count_normal: string;
     readonly count_slider: string;
     readonly count_spinner: string;
-    readonly max_combo: string;
+    readonly max_combo: string | null;
     readonly storyboard: string;
     readonly video: string;
     readonly download_unavailable: string;
@@ -3410,7 +3426,7 @@ interface OsuAPIResponse {
 /**
  * Represents a beatmap with general information.
  */
-declare class MapInfo<HasBeatmap extends boolean = boolean> {
+declare class MapInfo<THasBeatmap extends boolean = boolean> {
     /**
      * The title of the song of the beatmap.
      */
@@ -3518,7 +3534,7 @@ declare class MapInfo<HasBeatmap extends boolean = boolean> {
     /**
      * The maximum combo of the beatmap.
      */
-    maxCombo: number;
+    maxCombo: number | null;
     /**
      * The circle size of the beatmap.
      */
@@ -3582,7 +3598,7 @@ declare class MapInfo<HasBeatmap extends boolean = boolean> {
     /**
      * The decoded beatmap from beatmap decoder.
      */
-    get beatmap(): If<HasBeatmap, Beatmap>;
+    get beatmap(): If<THasBeatmap, Beatmap>;
     /**
      * The osu! site link to this beatmap.
      */
@@ -4268,7 +4284,7 @@ declare abstract class Polynomial {
  * Precision utilities.
  */
 declare abstract class Precision {
-    static readonly FLOAT_EPSILON: number;
+    static readonly FLOAT_EPSILON = 0.001;
     /**
      * Checks if two numbers are equal with a given tolerance.
      *