@rian8337/osu-difficulty-calculator 4.0.0-beta.0 → 4.0.0-beta.10

package/typings/index.d.ts

@@ -1,4 +1,4 @@
-import { MapStats, Mod, PlaceableHitObject, Modes, Beatmap, HitObject, Accuracy } from '@rian8337/osu-base';
+import { MapStats, Mod, PlaceableHitObject, Beatmap, Modes, HitObject, Accuracy } from '@rian8337/osu-base';
 
 /**
  * An evaluator for calculating aim skill.
@@ -68,6 +68,10 @@ interface DifficultyAttributes {
      * A value closer to 0 indicates most of aim difficulty is contributed by sliders.
      */
     sliderFactor: number;
+    /**
+     * The overall clock rate that was applied to the beatmap.
+     */
+    clockRate: number;
     /**
      * The perceived approach rate inclusive of rate-adjusting mods (DT/HT/etc).
      *
@@ -276,10 +280,9 @@ declare class DifficultyHitObject {
      *
      * @param time The time to calculate the hitobject's opacity at.
      * @param isHidden Whether Hidden mod is used.
-     * @param mode The gamemode to calculate the opacity for.
      * @returns The opacity of the hitobject at the given time.
      */
-    opacityAt(time: number, isHidden: boolean, mode: Modes): number;
+    opacityAt(time: number, isHidden: boolean): number;
     /**
      * Determines whether this hitobject is considered overlapping with the hitobject before it.
      *
@@ -353,7 +356,6 @@ declare abstract class StrainSkill extends Skill {
     protected abstract readonly strainDecayBase: number;
     private readonly sectionLength;
     private currentSectionEnd;
-    private isFirstObject;
     /**
      * Calculates the strain value of a hitobject and stores the value in it. This value is affected by previously processed objects.
      *
@@ -441,7 +443,6 @@ declare abstract class DifficultyCalculator {
      * Holds data that can be used to calculate performance points.
      */
     abstract readonly attributes: DifficultyAttributes;
-    protected readonly sectionLength: number;
     protected abstract readonly difficultyMultiplier: number;
     protected abstract readonly mode: Modes;
     /**
@@ -470,6 +471,10 @@ declare abstract class DifficultyCalculator {
      * Generates difficulty hitobjects for this calculator.
      */
     generateDifficultyHitObjects(): void;
+    /**
+     * Performs some pre-processing before proceeding with difficulty calculation.
+     */
+    protected preProcess(): void;
     /**
      * Calculates the skills provided.
      *
@@ -664,6 +669,26 @@ interface DroidDifficultyAttributes extends DifficultyAttributes {
      * The difficulty corresponding to the visual skill.
      */
     visualDifficulty: number;
+    /**
+     * The amount of strains that are considered difficult with respect to the aim skill.
+     */
+    aimDifficultStrainCount: number;
+    /**
+     * The amount of strains that are considered difficult with respect to the tap skill.
+     */
+    tapDifficultStrainCount: number;
+    /**
+     * The amount of strains that are considered difficult with respect to the flashlight skill.
+     */
+    flashlightDifficultStrainCount: number;
+    /**
+     * The amount of strains that are considered difficult with respect to the visual skill.
+     */
+    visualDifficultStrainCount: number;
+    /**
+     * The average delta time of speed objects.
+     */
+    averageSpeedDeltaTime: number;
 }
 
 /**
@@ -776,13 +801,8 @@ declare class DroidDifficultyCalculator extends DifficultyCalculator {
     calculateVisual(): void;
     calculateTotal(): void;
     calculateAll(): void;
-    /**
-     * Returns a string representative of the class.
-     */
     toString(): string;
-    /**
-     * Creates skills to be calculated.
-     */
+    protected preProcess(): void;
     protected createSkills(): DroidSkill[];
     /**
      * Called after aim skill calculation.
@@ -852,6 +872,7 @@ declare class DroidFlashlight extends DroidSkill {
      */
     protected strainValueAt(current: DifficultyHitObject): number;
     protected saveToHitObject(current: DifficultyHitObject): void;
+    difficultyValue(): number;
 }
 
 /**
@@ -1085,7 +1106,7 @@ declare class DroidPerformanceCalculator extends PerformanceCalculator {
      *
      * The aim and total performance value will be recalculated afterwards.
      *
-     * @param value The slider cheese penalty value. Must be between than 0 (exclusive) and 1 (inclusive).
+     * @param value The slider cheese penalty value. Must be between than 0 and 1.
      */
     applyAimSliderCheesePenalty(value: number): void;
     /**
@@ -1093,7 +1114,7 @@ declare class DroidPerformanceCalculator extends PerformanceCalculator {
      *
      * The flashlight and total performance value will be recalculated afterwards.
      *
-     * @param value The slider cheese penalty value. Must be between 0 (exclusive) and 1 (inclusive).
+     * @param value The slider cheese penalty value. Must be between 0 and 1.
      */
     applyFlashlightSliderCheesePenalty(value: number): void;
     /**
@@ -1101,7 +1122,7 @@ declare class DroidPerformanceCalculator extends PerformanceCalculator {
      *
      * The visual and total performance value will be recalculated afterwards.
      *
-     * @param value The slider cheese penalty value. Must be between 0 (exclusive) and 1 (inclusive).
+     * @param value The slider cheese penalty value. Must be between 0 and 1.
      */
     applyVisualSliderCheesePenalty(value: number): void;
     protected calculateValues(): void;
@@ -1127,6 +1148,14 @@ declare class DroidPerformanceCalculator extends PerformanceCalculator {
      * Calculates the visual performance value of the beatmap.
      */
     private calculateVisualValue;
+    /**
+     * Calculates miss penalty.
+     *
+     * Miss penalty assumes that a player will miss on the hardest parts of a map,
+     * so we use the amount of relatively difficult sections to adjust miss penalty
+     * to make it more punishing on maps with lower amount of hard sections.
+     */
+    private calculateMissPenalty;
     /**
      * Estimates the player's tap deviation based on the OD, number of circles and sliders,
      * and number of 300s, 100s, 50s, and misses, assuming the player's mean hit error is 0.
@@ -1174,6 +1203,7 @@ declare class DroidRhythm extends DroidSkill {
  * This class should be considered an "evaluating" class and not persisted.
  */
 declare abstract class RhythmEvaluator {
+    protected static readonly rhythmMultiplier: number;
     protected static readonly historyTimeMax: number;
 }
 
@@ -1189,12 +1219,6 @@ declare abstract class DroidRhythmEvaluator extends RhythmEvaluator {
      * @param greatWindow The great hit window of the current object.
      */
     static evaluateDifficultyOf(current: DifficultyHitObject, greatWindow: number): number;
-    /**
-     * Calculates the rhythm multiplier of a given hit window.
-     *
-     * @param greatWindow The great hit window.
-     */
-    private static calculateRhythmMultiplier;
 }
 
 /**
@@ -1257,7 +1281,7 @@ declare class DroidVisual extends DroidSkill {
     protected readonly skillMultiplier: number;
     protected readonly strainDecayBase: number;
     private readonly isHidden;
-    private readonly withSliders;
+    private readonly withsliders;
     constructor(mods: Mod[], withSliders: boolean);
     protected strainValueAt(current: DifficultyHitObject): number;
     protected saveToHitObject(current: DifficultyHitObject): void;
@@ -1350,13 +1374,8 @@ declare class OsuDifficultyCalculator extends DifficultyCalculator {
     calculateFlashlight(): void;
     calculateTotal(): void;
     calculateAll(): void;
-    /**
-     * Returns a string representative of the class.
-     */
     toString(): string;
-    /**
-     * Creates skills to be calculated.
-     */
+    protected preProcess(): void;
     protected createSkills(): OsuSkill[];
     /**
      * Called after aim skill calculation.
@@ -1537,7 +1556,6 @@ declare class OsuPerformanceCalculator extends PerformanceCalculator {
  * An evaluator for calculating osu!standard Rhythm skill.
  */
 declare abstract class OsuRhythmEvaluator extends RhythmEvaluator {
-    private static readonly rhythmMultiplier;
     /**
      * Calculates a rhythm multiplier for the difficulty of the tap associated
      * with historic data of the current object.
@@ -1560,7 +1578,6 @@ declare class OsuSpeed extends OsuSkill {
     protected readonly decayWeight: number;
     private currentSpeedStrain;
     private currentRhythm;
-    private readonly minSpeedBonus;
     private readonly greatWindow;
     constructor(mods: Mod[], greatWindow: number);
     /**