@rian8337/osu-base 2.1.0 → 2.2.0

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@rian8337/osu-base",
-  "version": "2.1.0",
+  "version": "2.2.0",
   "description": "Base module for all osu! related modules.",
   "keywords": [
     "osu",
@@ -20,7 +20,7 @@
     "build": "rollup -c ../../rollup.config.js",
     "lint": "eslint --ext ts",
     "prepare": "npm run build",
-    "test": "jest -i"
+    "test": "jest"
   },
   "repository": {
     "type": "git",
@@ -41,5 +41,5 @@
   "publishConfig": {
     "access": "public"
   },
-  "gitHead": "aa91d8c7ca9a687f63d920f402cf4f5771e04499"
+  "gitHead": "e8ab54978ffed744317da3dd0073bd4df4d97319"
 }

package/typings/index.d.ts

@@ -183,6 +183,9 @@ declare enum modes {
 declare abstract class Mod {
     /**
      * The score multiplier of this mod.
+     *
+     * @deprecated Score multipliers in droid and PC differ. Use `droidScoreMultiplier`
+     * for droid score multiplier and `pcScoreMultiplier` for PC multiplier instead.
      */
     abstract readonly scoreMultiplier: number;
     /**
@@ -201,8 +204,20 @@ declare abstract class Mod {
      * Whether the mod is ranked in osu!standard.
      */
     abstract readonly pcRanked: boolean;
+    /**
+     * The droid score multiplier of this mod.
+     */
+    abstract readonly droidScoreMultiplier: number;
+    /**
+     * The PC score multiplier of this mod.
+     */
+    abstract readonly pcScoreMultiplier: number;
     /**
      * The bitwise enum of the mod.
+     *
+     * This is NaN if the bitwise doesn't exist.
+     *
+     * In 3.0, this will be nullable.
      */
     abstract readonly bitwise: number;
     /**
@@ -982,9 +997,16 @@ declare class DifficultyControlPoint extends ControlPoint {
      * The slider speed multiplier of the control point.
      */
     readonly speedMultiplier: number;
+    /**
+     * 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).
+     */
+    readonly generateTicks: boolean;
     constructor(values: {
         time: number;
         speedMultiplier: number;
+        generateTicks?: boolean;
     });
     isRedundant(existing: DifficultyControlPoint): boolean;
     toString(): string;
@@ -1408,13 +1430,6 @@ declare class Beatmap {
      * @param mods The modifications to calculate for. Defaults to No Mod.
      */
     maxOsuScore(mods?: Mod[]): number;
-    /**
-     * Calculates the maximum score with a given difficulty and score multiplier.
-     *
-     * @param difficultyMultiplier The difficulty multiplier.
-     * @param scoreMultiplier The score multiplier.
-     */
-    private maxScore;
     /**
      * Returns a string representative of the class.
      */
@@ -1487,20 +1502,22 @@ declare abstract class SectionDecoder<T> {
      * @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.
      */
-    protected tryParseInt(str: string, min?: number, max?: number): number;
+    protected tryParseInt(str: string, min?: number, max?: number, allowNaN?: boolean): number;
     /**
      * 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.
      */
-    protected tryParseFloat(str: string, min?: number, max?: number): number;
+    protected tryParseFloat(str: string, min?: number, max?: number, allowNaN?: boolean): number;
     /**
      * Checks if a number is within a given threshold.
      *
@@ -1551,6 +1568,13 @@ declare abstract class Decoder<R, D extends SectionDecoder<R>> {
      * @returns The current decoder instance.
      */
     decode(str: string): this;
+    /**
+     * Determines whether a line should be skipped.
+     *
+     * @param line The line to determine.
+     * @returns Whether the line should be skipped.
+     */
+    protected shouldSkipLine(line: string): boolean;
     /**
      * Internal decoder function for decoding a line.
      *
@@ -2824,6 +2848,8 @@ declare class ModAuto extends Mod {
     readonly name: string;
     readonly droidRanked: boolean;
     readonly pcRanked: boolean;
+    readonly droidScoreMultiplier: number;
+    readonly pcScoreMultiplier: number;
     readonly bitwise: number;
     readonly droidString: string;
     readonly droidOnly: boolean;
@@ -2838,6 +2864,8 @@ declare class ModAutopilot extends Mod {
     readonly name: string;
     readonly droidRanked: boolean;
     readonly pcRanked: boolean;
+    readonly droidScoreMultiplier: number;
+    readonly pcScoreMultiplier: number;
     readonly bitwise: number;
     readonly droidString: string;
     readonly droidOnly: boolean;
@@ -2852,6 +2880,8 @@ declare class ModDoubleTime extends Mod {
     readonly name: string;
     readonly droidRanked: boolean;
     readonly pcRanked: boolean;
+    readonly droidScoreMultiplier: number;
+    readonly pcScoreMultiplier: number;
     readonly bitwise: number;
     readonly droidString: string;
     readonly droidOnly: boolean;
@@ -2866,6 +2896,8 @@ declare class ModEasy extends Mod {
     readonly name: string;
     readonly droidRanked: boolean;
     readonly pcRanked: boolean;
+    readonly droidScoreMultiplier: number;
+    readonly pcScoreMultiplier: number;
     readonly bitwise: number;
     readonly droidString: string;
     readonly droidOnly: boolean;
@@ -2880,6 +2912,8 @@ declare class ModFlashlight extends Mod {
     readonly name: string;
     readonly droidRanked: boolean;
     readonly pcRanked: boolean;
+    readonly droidScoreMultiplier: number;
+    readonly pcScoreMultiplier: number;
     readonly bitwise: number;
     readonly droidString: string;
     readonly droidOnly: boolean;
@@ -2894,6 +2928,8 @@ declare class ModHalfTime extends Mod {
     readonly name: string;
     readonly droidRanked: boolean;
     readonly pcRanked: boolean;
+    readonly droidScoreMultiplier: number;
+    readonly pcScoreMultiplier: number;
     readonly bitwise: number;
     readonly droidString: string;
     readonly droidOnly: boolean;
@@ -2909,6 +2945,8 @@ declare class ModHardRock extends Mod {
     readonly bitwise: number;
     readonly droidRanked: boolean;
     readonly pcRanked: boolean;
+    readonly droidScoreMultiplier: number;
+    readonly pcScoreMultiplier: number;
     readonly droidString: string;
     readonly droidOnly: boolean;
 }
@@ -2925,6 +2963,8 @@ declare class ModHidden extends Mod {
     readonly bitwise: number;
     readonly droidRanked: boolean;
     readonly pcRanked: boolean;
+    readonly droidScoreMultiplier: number;
+    readonly pcScoreMultiplier: number;
     readonly droidString: string;
     readonly droidOnly: boolean;
 }
@@ -2938,6 +2978,8 @@ declare class ModNightCore extends Mod {
     readonly name: string;
     readonly droidRanked: boolean;
     readonly pcRanked: boolean;
+    readonly droidScoreMultiplier: number;
+    readonly pcScoreMultiplier: number;
     readonly bitwise: number;
     readonly droidString: string;
     readonly droidOnly: boolean;
@@ -2952,6 +2994,8 @@ declare class ModNoFail extends Mod {
     readonly name: string;
     readonly droidRanked: boolean;
     readonly pcRanked: boolean;
+    readonly droidScoreMultiplier: number;
+    readonly pcScoreMultiplier: number;
     readonly bitwise: number;
     readonly droidString: string;
     readonly droidOnly: boolean;
@@ -2966,6 +3010,8 @@ declare class ModPerfect extends Mod {
     readonly name: string;
     readonly droidRanked: boolean;
     readonly pcRanked: boolean;
+    readonly droidScoreMultiplier: number;
+    readonly pcScoreMultiplier: number;
     readonly bitwise: number;
     readonly droidString: string;
     readonly droidOnly: boolean;
@@ -2980,6 +3026,8 @@ declare class ModPrecise extends Mod {
     readonly name: string;
     readonly droidRanked: boolean;
     readonly pcRanked: boolean;
+    readonly droidScoreMultiplier: number;
+    readonly pcScoreMultiplier: number;
     readonly bitwise: number;
     readonly droidString: string;
     readonly droidOnly: boolean;
@@ -2994,6 +3042,8 @@ declare class ModReallyEasy extends Mod {
     readonly name: string;
     readonly droidRanked: boolean;
     readonly pcRanked: boolean;
+    readonly droidScoreMultiplier: number;
+    readonly pcScoreMultiplier: number;
     readonly bitwise: number;
     readonly droidString: string;
     readonly droidOnly: boolean;
@@ -3008,6 +3058,8 @@ declare class ModRelax extends Mod {
     readonly name: string;
     readonly droidRanked: boolean;
     readonly pcRanked: boolean;
+    readonly droidScoreMultiplier: number;
+    readonly pcScoreMultiplier: number;
     readonly bitwise: number;
     readonly droidString: string;
     readonly droidOnly: boolean;
@@ -3022,6 +3074,8 @@ declare class ModScoreV2 extends Mod {
     readonly name: string;
     readonly droidRanked: boolean;
     readonly pcRanked: boolean;
+    readonly droidScoreMultiplier: number;
+    readonly pcScoreMultiplier: number;
     readonly bitwise: number;
     readonly droidString: string;
     readonly droidOnly: boolean;
@@ -3036,6 +3090,8 @@ declare class ModSmallCircle extends Mod {
     readonly name: string;
     readonly droidRanked: boolean;
     readonly pcRanked: boolean;
+    readonly droidScoreMultiplier: number;
+    readonly pcScoreMultiplier: number;
     readonly bitwise: number;
     readonly droidString: string;
     readonly droidOnly: boolean;
@@ -3050,6 +3106,8 @@ declare class ModSpunOut extends Mod {
     readonly name: string;
     readonly droidRanked: boolean;
     readonly pcRanked: boolean;
+    readonly droidScoreMultiplier: number;
+    readonly pcScoreMultiplier: number;
     readonly bitwise: number;
     readonly droidString: string;
     readonly droidOnly: boolean;
@@ -3064,6 +3122,8 @@ declare class ModSuddenDeath extends Mod {
     readonly name: string;
     readonly droidRanked: boolean;
     readonly pcRanked: boolean;
+    readonly droidScoreMultiplier: number;
+    readonly pcScoreMultiplier: number;
     readonly bitwise: number;
     readonly droidString: string;
     readonly droidOnly: boolean;
@@ -3078,6 +3138,8 @@ declare class ModTouchDevice extends Mod {
     readonly name: string;
     readonly droidRanked: boolean;
     readonly pcRanked: boolean;
+    readonly droidScoreMultiplier: number;
+    readonly pcScoreMultiplier: number;
     readonly bitwise: number;
     readonly droidString: string;
     readonly droidOnly: boolean;