@rian8337/osu-difficulty-calculator 1.3.0 → 1.4.12

package/typings/index.d.ts

@@ -52,6 +52,10 @@ declare module "@rian8337/osu-difficulty-calculator" {
          * The flashlight strain generated by the hitobject.
          */
         flashlightStrain: number;
+        /**
+         * The visual strain generated by the hitobject.
+         */
+        visualStrain: number;
         /**
          * The normalized distance from the "lazy" end position of the previous hitobject to the start position of this hitobject.
          *
@@ -101,6 +105,24 @@ declare module "@rian8337/osu-difficulty-calculator" {
          * Adjusted start time of the hitobject, taking speed multiplier into account.
          */
         startTime: number;
+        /**
+         * Adjusted end time of the hitobject, taking speed multiplier into account.
+         */
+        endTime: number;
+        /**
+         * The note density of the hitobject.
+         */
+        noteDensity: number;
+        /**
+         * The overlapping factor of the hitobject.
+         *
+         * This is used to scale visual skill.
+         */
+        overlappingFactor: number;
+        /**
+         * Adjusted velocity of the hitobject, taking speed multiplier into account.
+         */
+        velocity: number;
         /**
          * @param object The underlying hitobject.
          */
@@ -135,6 +157,7 @@ declare module "@rian8337/osu-difficulty-calculator" {
             circleSize: number;
             speedMultiplier: number;
             mode: modes;
+            preempt?: number;
         }): DifficultyHitObject[];
         /**
          * Calculates a slider's cursor position.
@@ -182,7 +205,7 @@ declare module "@rian8337/osu-difficulty-calculator" {
          */
         protected override strainValueAt(current: DifficultyHitObject): number;
         /**
-         * @param currentObject The hitobject to save to.
+         * @param current The hitobject to save to.
          */
         protected override saveToHitObject(current: DifficultyHitObject): void;
     }
@@ -210,6 +233,7 @@ declare module "@rian8337/osu-difficulty-calculator" {
          */
         protected override saveToHitObject(current: DifficultyHitObject): void;
     }
+
     /**
      * A performance points calculator that calculates performance points for osu!droid gamemode.
      */
@@ -232,7 +256,11 @@ declare module "@rian8337/osu-difficulty-calculator" {
          * The flashlight performance value.
          */
         flashlight: number;
-        private averageRhythmMultiplier: number;
+        /**
+         * The visual performance value.
+         */
+        visual: number;
+        private tapPenalty: number;
         override calculate(params: {
             /**
              * The star rating instance to calculate.
@@ -259,10 +287,8 @@ declare module "@rian8337/osu-difficulty-calculator" {
              */
             stats?: MapStats;
         }): this;
-        /**
-         * Calculates the average rhythm multiplier of the beatmap.
-         */
-        private calculateAverageRhythmMultiplier(): void;
+        protected override calculateValues(): void;
+        protected override calculateTotalValue(): number;
         /**
          * Calculates the aim performance value of the beatmap.
          */
@@ -279,6 +305,10 @@ declare module "@rian8337/osu-difficulty-calculator" {
          * Calculates the flashlight performance value of the beatmap.
          */
         private calculateFlashlightValue(): void;
+        /**
+         * Calculates the visual performance value of the beatmap.
+         */
+        private calculateVisualValue(): void;
         override toString(): string;
     }
 
@@ -317,10 +347,18 @@ declare module "@rian8337/osu-difficulty-calculator" {
          * The tap star rating of the beatmap.
          */
         tap: number;
+        /**
+         * The rhythm star rating of the beatmap.
+         */
+        rhythm: number;
         /**
          * The flashlight star rating of the beatmap.
          */
         flashlight: number;
+        /**
+         * The visual star rating of the beatmap.
+         */
+        visual: number;
         protected override readonly difficultyMultiplier: number;
         /**
          * Calculates the star rating of the specified beatmap.
@@ -363,17 +401,19 @@ declare module "@rian8337/osu-difficulty-calculator" {
          */
         calculateTap(): void;
         /**
-         * Calculates the flashlight star rating of the beatmap and stores it in this instance.
+         * Calculates the rhythm star rating of the beatmap and stores it in this instance.
          */
-        calculateFlashlight(): void;
+        calculateRhythm(): void;
         /**
-         * Calculates the total star rating of the beatmap and stores it in this instance.
+         * Calculates the flashlight star rating of the beatmap and stores it in this instance.
          */
-        calculateTotal(): void;
+        calculateFlashlight(): void;
         /**
-         * Calculates every star rating of the beatmap and stores it in this instance.
+         * Calculates the visual star rating of the beatmap and stores it in this instance.
          */
-        calculateAll(): void;
+        calculateVisual(): void;
+        override calculateTotal(): void;
+        override calculateAll(): void;
         /**
          * Returns a string representative of the class.
          */
@@ -399,9 +439,9 @@ declare module "@rian8337/osu-difficulty-calculator" {
          */
         private postCalculateTap(tapSkill: DroidTap): void;
         /**
-         * Calculates the speed note count attribute.
+         * Calculates speed-related attributes.
          */
-        private calculateSpeedNoteCount(): void;
+        private calculateSpeedAttributes(): void;
         /**
          * Called after rhythm skill calculation.
          *
@@ -414,13 +454,18 @@ declare module "@rian8337/osu-difficulty-calculator" {
          * @param flashlightSkill The flashlight skill.
          */
         private postCalculateFlashlight(flashlightSkill: DroidFlashlight): void;
+        /**
+         * Called after visual skill calculation.
+         *
+         * @param visualSkill The visual skill.
+         */
+        private postCalculateVisual(visualSkill: DroidVisual): void;
     }
 
     /**
      * Represents the skill required to press keys or tap with regards to keeping up with the speed at which objects need to be hit.
      */
     export class DroidTap extends DroidSkill {
-        protected override readonly historyLength: number;
         protected override readonly skillMultiplier: number;
         protected override readonly strainDecayBase: number;
         protected override readonly reducedSectionBaseline: number;
@@ -429,10 +474,6 @@ declare module "@rian8337/osu-difficulty-calculator" {
         private readonly minSpeedBonus: number;
         private currentTapStrain: number;
         private currentOriginalTapStrain: number;
-        private readonly rhythmMultiplier: number;
-        private readonly historyTimeMax: number;
-        private currentRhythm: number;
-        private readonly overallDifficulty: number;
         private readonly hitWindow: OsuHitWindow;
         constructor(mods: Mod[], overallDifficulty: number);
         /**
@@ -453,6 +494,32 @@ declare module "@rian8337/osu-difficulty-calculator" {
         protected override saveToHitObject(current: DifficultyHitObject): void;
     }
 
+    /**
+     * Represents the skill required to read every object in the map.
+     */
+    export class DroidVisual extends DroidSkill {
+        protected override readonly skillMultiplier: number;
+        protected override readonly strainDecayBase: number;
+        protected override readonly reducedSectionBaseline: number;
+        protected override readonly reducedSectionCount: number;
+        protected override readonly starsPerDouble: number;
+        private readonly preempt: number;
+        private readonly isHidden: boolean;
+        constructor(mods: Mod[], preempt: number);
+        /**
+         * @param current The hitobject to calculate.
+         */
+        protected strainValueOf(current: DifficultyHitObject): number;
+        /**
+         * @param current The hitobject to calculate.
+         */
+        protected override strainValueAt(current: DifficultyHitObject): number;
+        /**
+         * @param current The hitobject to save to.
+         */
+        protected override saveToHitObject(current: DifficultyHitObject): void;
+    }
+
     /**
      * A star rating calculator that configures which mode to calculate difficulty for and what mods are applied.
      */
@@ -587,6 +654,8 @@ declare module "@rian8337/osu-difficulty-calculator" {
              */
             stats?: MapStats;
         }): this;
+        protected override calculateValues(): void;
+        protected override calculateTotalValue(): number;
         /**
          * Calculates the aim performance value of the beatmap.
          */
@@ -621,13 +690,9 @@ declare module "@rian8337/osu-difficulty-calculator" {
         protected override readonly reducedSectionBaseline: number;
         protected override readonly difficultyMultiplier: number;
         protected override readonly decayWeight: number;
-        private readonly rhythmMultiplier: number;
-        private readonly historyTimeMax: number;
-        private currentSpeedStrain: number;
-        private currentRhythm: number;
         private readonly minSpeedBonus: number;
-        private readonly greatWindow: number;
-        constructor(mods: Mod[], greatWindow: number);
+        private readonly maxSpeedBonus: number;
+        private readonly angleBonusScale: number;
         /**
          * @param current The hitobject to calculate.
          */
@@ -689,14 +754,8 @@ declare module "@rian8337/osu-difficulty-calculator" {
          * Calculates the flashlight star rating of the beatmap and stores it in this instance.
          */
         calculateFlashlight(): void;
-        /**
-         * Calculates the total star rating of the beatmap and stores it in this instance.
-         */
-        calculateTotal(): void;
-        /**
-         * Calculates every star rating of the beatmap and stores it in this instance.
-         */
-        calculateAll(): void;
+        override calculateTotal(): void;
+        override calculateAll(): void;
         /**
          * Returns a string representative of the class.
          */
@@ -739,6 +798,8 @@ declare module "@rian8337/osu-difficulty-calculator" {
     export interface DifficultyAttributes {
         speedNoteCount: number;
         sliderFactor: number;
+        aimDifficultStrainCount: number;
+        speedDifficultStrainCount: number;
     }
 
     /**
@@ -867,10 +928,6 @@ declare module "@rian8337/osu-difficulty-calculator" {
              * The amount of misses achieved in the score.
              */
             miss?: number;
-            /**
-             * The gamemode to calculate.
-             */
-            mode?: modes;
             /**
              * The tap penalty to apply for penalized scores. Only applies to droid gamemode.
              */
@@ -885,13 +942,53 @@ declare module "@rian8337/osu-difficulty-calculator" {
          */
         abstract toString(): string;
         /**
-         * Calculates the base performance value for of a star rating.
+         * Internal calculation method, used to process calculation from implementations.
+         */
+        protected calculateInternal(
+            params: {
+                /**
+                 * The star rating instance to calculate.
+                 */
+                stars: StarRating;
+                /**
+                 * The maximum combo achieved in the score.
+                 */
+                combo?: number;
+                /**
+                 * The accuracy achieved in the score.
+                 */
+                accPercent?: Accuracy | number;
+                /**
+                 * The amount of misses achieved in the score.
+                 */
+                miss?: number;
+                /**
+                 * The tap penalty to apply for penalized scores. Only applies to droid gamemode.
+                 */
+                tapPenalty?: number;
+                /**
+                 * Custom map statistics to apply custom speed multiplier and force AR values as well as old statistics.
+                 */
+                stats?: MapStats;
+            },
+            mode: modes
+        ): this;
+        /**
+         * Calculates values that will be used for calculating the total performance value of the beatmap.
+         */
+        protected abstract calculateValues(): void;
+        /**
+         * Calculates the total performance value of the beatmap.
+         */
+        protected abstract calculateTotalValue(): number;
+        /**
+         * Calculates the base performance value of a star rating.
          */
         protected baseValue(stars: number): number;
         /**
          * Processes given parameters for usage in performance calculation.
          */
-        protected handleParams(
+        private handleParams(
             params: {
                 /**
                  * The star rating instance to calculate.
@@ -909,10 +1006,6 @@ declare module "@rian8337/osu-difficulty-calculator" {
                  * The amount of misses achieved in the score.
                  */
                 miss?: number;
-                /**
-                 * The gamemode to calculate.
-                 */
-                mode?: modes;
                 /**
                  * The tap penalty to apply for penalized scores.
                  */
@@ -964,6 +1057,89 @@ declare module "@rian8337/osu-difficulty-calculator" {
         abstract difficultyValue(): 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.
+     */
+    abstract class StrainSkill extends Skill {
+        /**
+         * The strain of currently calculated hitobject.
+         */
+        protected currentStrain: number;
+
+        /**
+         * The current section's strain peak.
+         */
+        protected currentSectionPeak: number;
+
+        /**
+         * Strain peaks are stored here.
+         */
+        readonly strainPeaks: number[];
+        /**
+         * The number of sections with the highest strains, which the peak strain reductions will apply to.
+         * This is done in order to decrease their impact on the overall difficulty of the map for this skill.
+         */
+        protected abstract readonly reducedSectionCount: number;
+
+        /**
+         * The baseline multiplier applied to the section with the biggest strain.
+         */
+        protected abstract readonly reducedSectionBaseline: number;
+
+        /**
+         * Strain values are multiplied by this number for the given skill. Used to balance the value of different skills between each other.
+         */
+        protected abstract readonly skillMultiplier: number;
+
+        /**
+         * Determines how quickly strain decays for the given skill.
+         *
+         * For example, a value of 0.15 indicates that strain decays to 15% of its original value in one second.
+         */
+        protected abstract readonly strainDecayBase: number;
+
+        protected readonly sectionLength: number;
+
+        protected currentSectionEnd: number;
+
+        /**
+         * Calculates the strain value of a hitobject and stores the value in it. This value is affected by previously processed objects.
+         *
+         * @param current The hitobject to process.
+         */
+        protected override process(current: DifficultyHitObject): void;
+
+        /**
+         * Saves the current peak strain level to the list of strain peaks, which will be used to calculate an overall difficulty.
+         */
+        saveCurrentPeak(): void;
+
+        /**
+         * Sets the initial strain level for a new section.
+         *
+         * @param offset The beginning of the new section in milliseconds, adjusted by speed multiplier.
+         */
+        protected startNewSectionFrom(offset: number): void;
+
+        /**
+         * Calculates strain decay for a specified time frame.
+         *
+         * @param ms The time frame to calculate.
+         */
+        protected strainDecay(ms: number): number;
+
+        /**
+         * Calculates the strain value at a hitobject.
+         */
+        protected abstract strainValueAt(current: DifficultyHitObject): number;
+
+        /**
+         * Saves the current strain to a hitobject.
+         */
+        protected abstract saveToHitObject(current: DifficultyHitObject): void;
+    }
+
     /**
      * The base of difficulty calculation.
      */
@@ -1075,88 +1251,5 @@ declare module "@rian8337/osu-difficulty-calculator" {
         protected basePerformanceValue(rating: number): 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.
-     */
-    abstract class StrainSkill extends Skill {
-        /**
-         * The strain of currently calculated hitobject.
-         */
-        protected currentStrain: number;
-
-        /**
-         * The current section's strain peak.
-         */
-        protected currentSectionPeak: number;
-
-        /**
-         * Strain peaks are stored here.
-         */
-        readonly strainPeaks: number[];
-        /**
-         * The number of sections with the highest strains, which the peak strain reductions will apply to.
-         * This is done in order to decrease their impact on the overall difficulty of the map for this skill.
-         */
-        protected abstract readonly reducedSectionCount: number;
-
-        /**
-         * The baseline multiplier applied to the section with the biggest strain.
-         */
-        protected abstract readonly reducedSectionBaseline: number;
-
-        /**
-         * Strain values are multiplied by this number for the given skill. Used to balance the value of different skills between each other.
-         */
-        protected abstract readonly skillMultiplier: number;
-
-        /**
-         * Determines how quickly strain decays for the given skill.
-         *
-         * For example, a value of 0.15 indicates that strain decays to 15% of its original value in one second.
-         */
-        protected abstract readonly strainDecayBase: number;
-
-        protected readonly sectionLength: number;
-
-        protected currentSectionEnd: number;
-
-        /**
-         * Calculates the strain value of a hitobject and stores the value in it. This value is affected by previously processed objects.
-         *
-         * @param current The hitobject to process.
-         */
-        protected override process(current: DifficultyHitObject): void;
-
-        /**
-         * Saves the current peak strain level to the list of strain peaks, which will be used to calculate an overall difficulty.
-         */
-        saveCurrentPeak(): void;
-
-        /**
-         * Sets the initial strain level for a new section.
-         *
-         * @param offset The beginning of the new section in milliseconds, adjusted by speed multiplier.
-         */
-        protected startNewSectionFrom(offset: number): void;
-
-        /**
-         * Calculates strain decay for a specified time frame.
-         *
-         * @param ms The time frame to calculate.
-         */
-        protected strainDecay(ms: number): number;
-
-        /**
-         * Calculates the strain value at a hitobject.
-         */
-        protected abstract strainValueAt(current: DifficultyHitObject): number;
-
-        /**
-         * Saves the current strain to a hitobject.
-         */
-        protected abstract saveToHitObject(current: DifficultyHitObject): void;
-    }
-
     //#endregion
 }