@rian8337/osu-difficulty-calculator 4.0.0-beta.77 → 4.0.0-beta.79

package/package.json

@@ -1,6 +1,6 @@
 {
     "name": "@rian8337/osu-difficulty-calculator",
-    "version": "4.0.0-beta.77",
+    "version": "4.0.0-beta.79",
     "description": "A module for calculating osu!standard beatmap difficulty and performance value with respect to the current difficulty and performance algorithm.",
     "keywords": [
         "osu",
@@ -33,10 +33,10 @@
         "url": "https://github.com/Rian8337/osu-droid-module/issues"
     },
     "dependencies": {
-        "@rian8337/osu-base": "^4.0.0-beta.77"
+        "@rian8337/osu-base": "^4.0.0-beta.78"
     },
     "publishConfig": {
         "access": "public"
     },
-    "gitHead": "13ad454ea657dbd5821d0857c4da6dc7ab0fe965"
+    "gitHead": "f74fd671070428e18592487c6a70a8844c72d0d8"
 }

package/typings/index.d.ts

@@ -209,6 +209,10 @@ declare abstract class DifficultyHitObject {
      * The full great window of the hitobject.
      */
     readonly fullGreatWindow: number;
+    /**
+     * Selective bonus for beatmaps with higher circle size.
+     */
+    abstract get smallCircleBonus(): number;
     /**
      * Other hitobjects in the beatmap, including this hitobject.
      */
@@ -246,9 +250,8 @@ declare abstract class DifficultyHitObject {
      * Computes the properties of this hitobject.
      *
      * @param clockRate The clock rate of the beatmap.
-     * @param hitObjects The hitobjects in the beatmap.
      */
-    computeProperties(clockRate: number, hitObjects: readonly PlaceableHitObject[]): void;
+    computeProperties(clockRate: number): void;
     /**
      * Gets the difficulty hitobject at a specific index with respect to the current
      * difficulty hitobject's index.
@@ -286,7 +289,6 @@ declare abstract class DifficultyHitObject {
      * A value closer to 1 indicates a higher possibility.
      */
     get doubletapness(): number;
-    protected abstract get scalingFactor(): number;
     protected setDistances(clockRate: number): void;
     private calculateSliderCursorPosition;
     private getEndCursorPosition;
@@ -381,7 +383,7 @@ declare abstract class StrainSkill extends Skill {
      *
      * The result is scaled by clock rate as it affects the total number of strains.
      */
-    countDifficultStrains(): number;
+    countTopWeightedStrains(): number;
     /**
      * Calculates strain decay for a specified time frame.
      *
@@ -567,13 +569,9 @@ declare class DroidDifficultyHitObject extends DifficultyHitObject {
      */
     flashlightStrainWithoutSliders: number;
     /**
-     * The visual strain generated by the hitobject if sliders are considered.
-     */
-    visualStrainWithSliders: number;
-    /**
-     * The visual strain generated by the hitobject if sliders are not considered.
+     * The reading difficulty generated by the hitobject.
      */
-    visualStrainWithoutSliders: number;
+    readingDifficulty: number;
     /**
      * The note density of the hitobject.
      */
@@ -591,7 +589,7 @@ declare class DroidDifficultyHitObject extends DifficultyHitObject {
     private readonly radiusBuffThreshold;
     protected readonly mode = Modes.droid;
     protected readonly maximumSliderRadius: number;
-    protected get scalingFactor(): number;
+    get smallCircleBonus(): number;
     /**
      * Note: You **must** call `computeProperties` at some point due to how TypeScript handles
      * overridden properties (see [this](https://github.com/microsoft/TypeScript/issues/1617) GitHub issue).
@@ -602,7 +600,6 @@ declare class DroidDifficultyHitObject extends DifficultyHitObject {
      * @param clockRate The clock rate of the beatmap.
      */
     constructor(object: PlaceableHitObject, lastObject: PlaceableHitObject | null, difficultyHitObjects: readonly DifficultyHitObject[], clockRate: number, index: number);
-    computeProperties(clockRate: number, hitObjects: readonly PlaceableHitObject[]): void;
     opacityAt(time: number, mods: ModMap): number;
     previous(backwardsIndex: number): this | null;
     next(forwardsIndex: number): this | null;
@@ -619,8 +616,6 @@ declare class DroidDifficultyHitObject extends DifficultyHitObject {
      * @returns Whether the hitobject is considered overlapping.
      */
     isOverlapping(considerDistance: boolean): boolean;
-    private setVisuals;
-    private applyToOverlappingFactor;
 }
 
 /**
@@ -655,6 +650,7 @@ declare class DroidAim extends DroidSkill {
     private readonly skillMultiplier;
     private currentAimStrain;
     private readonly sliderStrains;
+    private maxSliderStrain;
     readonly withSliders: boolean;
     constructor(mods: ModMap, withSliders: boolean);
     /**
@@ -718,9 +714,9 @@ interface IDroidDifficultyAttributes extends IDifficultyAttributes {
      */
     rhythmDifficulty: number;
     /**
-     * The difficulty corresponding to the visual skill.
+     * The difficulty corresponding to the reading skill.
      */
-    visualDifficulty: number;
+    readingDifficulty: number;
     /**
      * The amount of strains that are considered difficult with respect to the tap skill.
      */
@@ -730,9 +726,9 @@ interface IDroidDifficultyAttributes extends IDifficultyAttributes {
      */
     flashlightDifficultStrainCount: number;
     /**
-     * The amount of strains that are considered difficult with respect to the visual skill.
+     * The amount of notes that are considered difficult with respect to the reading skill.
      */
-    visualDifficultStrainCount: number;
+    readingDifficultNoteCount: number;
     /**
      * The average delta time of speed objects.
      */
@@ -753,10 +749,10 @@ interface IDroidDifficultyAttributes extends IDifficultyAttributes {
 declare class DroidDifficultyAttributes extends DifficultyAttributes implements IDroidDifficultyAttributes {
     tapDifficulty: number;
     rhythmDifficulty: number;
-    visualDifficulty: number;
+    readingDifficulty: number;
     tapDifficultStrainCount: number;
     flashlightDifficultStrainCount: number;
-    visualDifficultStrainCount: number;
+    readingDifficultNoteCount: number;
     averageSpeedDeltaTime: number;
     vibroFactor: number;
     constructor(cacheableAttributes?: CacheableDifficultyAttributes<IDroidDifficultyAttributes>);
@@ -798,12 +794,6 @@ interface IExtendedDroidDifficultyAttributes extends IDroidDifficultyAttributes
      * Sliders that are considered difficult.
      */
     difficultSliders: DifficultSlider[];
-    /**
-     * The number of clickable objects weighted by difficulty.
-     *
-     * Related to aim difficulty.
-     */
-    aimNoteCount: number;
     /**
      * Describes how much of flashlight difficulty is contributed to by hitcircles or sliders.
      *
@@ -812,14 +802,6 @@ interface IExtendedDroidDifficultyAttributes extends IDroidDifficultyAttributes
      * A value closer to 0 indicates most of flashlight difficulty is contributed by sliders.
      */
     flashlightSliderFactor: number;
-    /**
-     * Describes how much of visual difficulty is contributed to by hitcircles or sliders.
-     *
-     * A value closer to 1 indicates most of visual difficulty is contributed by hitcircles.
-     *
-     * A value closer to 0 indicates most of visual difficulty is contributed by sliders.
-     */
-    visualSliderFactor: number;
 }
 
 /**
@@ -830,9 +812,7 @@ declare class ExtendedDroidDifficultyAttributes extends DroidDifficultyAttribute
     mode: "live";
     possibleThreeFingeredSections: HighStrainSection[];
     difficultSliders: DifficultSlider[];
-    aimNoteCount: number;
     flashlightSliderFactor: number;
-    visualSliderFactor: number;
     constructor(cacheableAttributes?: CacheableDifficultyAttributes<IExtendedDroidDifficultyAttributes>);
 }
 
@@ -852,13 +832,13 @@ declare class DroidDifficultyCalculator extends DifficultyCalculator<DroidPlayab
     protected createDifficultyAttributes(beatmap: DroidPlayableBeatmap, skills: Skill[], objects: DroidDifficultyHitObject[]): ExtendedDroidDifficultyAttributes;
     protected createPlayableBeatmap(beatmap: Beatmap, mods?: ModMap): DroidPlayableBeatmap;
     protected createDifficultyHitObjects(beatmap: DroidPlayableBeatmap): DroidDifficultyHitObject[];
-    protected createSkills(beatmap: DroidPlayableBeatmap): DroidSkill[];
+    protected createSkills(beatmap: DroidPlayableBeatmap): Skill[];
     protected createStrainPeakSkills(beatmap: DroidPlayableBeatmap): StrainSkill[];
     private populateAimAttributes;
     private populateTapAttributes;
     private populateRhythmAttributes;
     private populateFlashlightAttributes;
-    private populateVisualAttributes;
+    private populateReadingAttributes;
 }
 
 /**
@@ -1090,9 +1070,9 @@ declare class DroidPerformanceCalculator extends PerformanceCalculator<IDroidDif
      */
     flashlight: number;
     /**
-     * The visual performance value.
+     * The reading performance value.
      */
-    visual: number;
+    reading: number;
     /**
      * The penalty used to penalize the tap performance value.
      *
@@ -1119,17 +1099,10 @@ declare class DroidPerformanceCalculator extends PerformanceCalculator<IDroidDif
      * Can be properly obtained by analyzing the replay associated with the score.
      */
     get flashlightSliderCheesePenalty(): number;
-    /**
-     * The penalty used to penalize the visual performance value.
-     *
-     * Can be properly obtained by analyzing the replay associated with the score.
-     */
-    get visualSliderCheesePenalty(): number;
     protected finalMultiplier: number;
     protected readonly mode = Modes.droid;
     private _aimSliderCheesePenalty;
     private _flashlightSliderCheesePenalty;
-    private _visualSliderCheesePenalty;
     private _tapPenalty;
     private _deviation;
     private _tapDeviation;
@@ -1157,14 +1130,6 @@ declare class DroidPerformanceCalculator extends PerformanceCalculator<IDroidDif
      * @param value The slider cheese penalty value. Must be between 0 and 1.
      */
     applyFlashlightSliderCheesePenalty(value: number): void;
-    /**
-     * Applies a visual slider cheese penalty value to this calculator.
-     *
-     * The visual and total performance value will be recalculated afterwards.
-     *
-     * @param value The slider cheese penalty value. Must be between 0 and 1.
-     */
-    applyVisualSliderCheesePenalty(value: number): void;
     protected calculateValues(): void;
     protected calculateTotalValue(): number;
     protected handleOptions(options?: PerformanceCalculationOptions): void;
@@ -1185,9 +1150,9 @@ declare class DroidPerformanceCalculator extends PerformanceCalculator<IDroidDif
      */
     private calculateFlashlightValue;
     /**
-     * Calculates the visual performance value of the beatmap.
+     * Calculates the reading performance value of the beatmap.
      */
-    private calculateVisualValue;
+    private calculateReadingValue;
     /**
      * The object-based proportional miss penalty.
      */
@@ -1202,7 +1167,7 @@ declare class DroidPerformanceCalculator extends PerformanceCalculator<IDroidDif
      */
     private calculateDeviationBasedLengthScaling;
     /**
-     * Estimates the player's tap deviation based on the OD, number of circles and sliders,
+     * Estimates the player's 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.
      *
      * The estimation is consistent in that two SS scores on the same map
@@ -1223,10 +1188,80 @@ declare class DroidPerformanceCalculator extends PerformanceCalculator<IDroidDif
      * This is fine though, since this method is only used to scale tap pp.
      */
     private calculateTapDeviation;
+    /**
+     * Calculates a multiplier for tap to account for improper tapping based on the deviation and tap difficulty.
+     *
+     * [Graph](https://www.desmos.com/calculator/z5l9ebrwpi)
+     */
+    private calculateTapHighDeviationNerf;
     private getConvertedHitWindow;
     toString(): string;
 }
 
+/**
+ * Represents the skill required to read every object in the map.
+ */
+declare class DroidReading extends Skill {
+    private readonly clockRate;
+    private readonly hitObjects;
+    private readonly noteDifficulties;
+    private readonly strainDecayBase;
+    private readonly skillMultiplier;
+    private currentNoteDifficulty;
+    private difficulty;
+    private noteWeightSum;
+    constructor(mods: ModMap, clockRate: number, hitObjects: readonly PlaceableHitObject[]);
+    process(current: DroidDifficultyHitObject): void;
+    difficultyValue(): number;
+    /**
+     * Returns the number of relevant objects weighted against the top note.
+     */
+    countTopWeightedNotes(): number;
+    private strainDecay;
+}
+
+/**
+ * An evaluator for calculating osu!droid reading skill.
+ */
+declare abstract class DroidReadingEvaluator {
+    private static readonly emptyModMap;
+    private static readonly readingWindowSize;
+    private static readonly distanceInfluenceThreshold;
+    private static readonly hiddenMultiplier;
+    private static readonly densityMultiplier;
+    private static readonly densityDifficultyBase;
+    private static readonly preemptBalancingFactor;
+    private static readonly preemptStartingPoint;
+    static evaluateDifficultyOf(current: DroidDifficultyHitObject, clockRate: number, mods: ModMap): number;
+    /**
+     * Retrieves a list of objects that are visible at the point in time the current object needs to be hit.
+     *
+     * @param current The current object.
+     */
+    private static retrievePastVisibleObjects;
+    /**
+     * Calculates the density of objects visible at the point in time the current object needs to be hit.
+     *
+     * @param current The current object.
+     */
+    private static calculateCurrentVisibleObjectsDensity;
+    /**
+     * Returns the time an object spends invisible with the Hidden mod at the current approach rate.
+     *
+     * @param current The current object.
+     */
+    private static getDurationSpentInvisible;
+    /**
+     * Calculates a factor of how often the current object's angle has been repeated in a certain time frame.
+     * It does this by checking the difference in angle between current and past objects and sums them up
+     * based on a range of similarity.
+     *
+     * @param current The current object.
+     */
+    private static getConstantAngleNerfFactor;
+    private static getTimeNerfFactor;
+}
+
 /**
  * Represents the skill required to properly follow a beatmap's rhythm.
  */
@@ -1275,12 +1310,13 @@ declare class DroidTap extends DroidSkill {
     private currentRhythmMultiplier;
     private readonly skillMultiplier;
     private readonly _objectDeltaTimes;
+    private maxStrain;
     /**
      * The delta time of hitobjects.
      */
     get objectDeltaTimes(): readonly number[];
     readonly considerCheesability: boolean;
-    private readonly strainTimeCap?;
+    readonly strainTimeCap?: number;
     constructor(mods: ModMap, considerCheesability: boolean, strainTimeCap?: number);
     /**
      * The amount of notes that are relevant to the difficulty.
@@ -1319,47 +1355,6 @@ declare abstract class DroidTapEvaluator {
     static evaluateDifficultyOf(current: DroidDifficultyHitObject, considerCheesability: boolean, strainTimeCap?: number): number;
 }
 
-/**
- * Represents the skill required to read every object in the map.
- */
-declare class DroidVisual extends DroidSkill {
-    protected readonly starsPerDouble = 1.025;
-    protected readonly reducedSectionCount = 10;
-    protected readonly reducedSectionBaseline = 0.75;
-    protected readonly strainDecayBase = 0.1;
-    private currentVisualStrain;
-    private currentRhythmMultiplier;
-    private readonly skillMultiplier;
-    readonly withSliders: boolean;
-    constructor(mods: ModMap, withSliders: boolean);
-    protected strainValueAt(current: DroidDifficultyHitObject): number;
-    protected calculateInitialStrain(time: number, current: DroidDifficultyHitObject): number;
-    protected getObjectStrain(): number;
-    protected saveToHitObject(current: DroidDifficultyHitObject): void;
-}
-
-/**
- * An evaluator for calculating osu!droid visual skill.
- */
-declare abstract class DroidVisualEvaluator {
-    /**
-     * Evaluates the difficulty of reading the current object, based on:
-     *
-     * - note density of the current object,
-     * - overlapping factor of the current object,
-     * - the preempt time of the current object,
-     * - the visual opacity of the current object,
-     * - the velocity of the current object if it's a slider,
-     * - past objects' velocity if they are sliders,
-     * - and whether the Hidden mod is enabled.
-     *
-     * @param current The current object.
-     * @param mods The mods used.
-     * @param withSliders Whether to take slider difficulty into account.
-     */
-    static evaluateDifficultyOf(current: DroidDifficultyHitObject, mods: ModMap, withSliders: boolean): number;
-}
-
 /**
  * Holds data that can be used to calculate osu!standard performance points.
  */
@@ -1392,9 +1387,8 @@ declare class OsuDifficultyHitObject extends DifficultyHitObject {
      * The flashlight strain generated by this hitobject.
      */
     flashlightStrain: number;
-    private readonly radiusBuffThreshold;
+    get smallCircleBonus(): number;
     protected readonly mode = Modes.osu;
-    protected get scalingFactor(): number;
 }
 
 /**
@@ -1623,6 +1617,7 @@ declare class OsuSpeed extends OsuSkill {
     private currentSpeedStrain;
     private currentRhythm;
     private readonly skillMultiplier;
+    private maxStrain;
     /**
      * The amount of notes that are relevant to the difficulty.
      */
@@ -1663,4 +1658,4 @@ declare abstract class OsuSpeedEvaluator {
     static evaluateDifficultyOf(current: OsuDifficultyHitObject, mods: ModMap): number;
 }
 
-export { type CacheableDifficultyAttributes, type DifficultSlider, DifficultyAttributes, DifficultyCalculator, DifficultyHitObject, DroidAim, DroidAimEvaluator, DroidDifficultyAttributes, DroidDifficultyCalculator, DroidDifficultyHitObject, DroidFlashlight, DroidFlashlightEvaluator, DroidPerformanceCalculator, DroidRhythm, DroidRhythmEvaluator, DroidTap, DroidTapEvaluator, DroidVisual, DroidVisualEvaluator, ExtendedDroidDifficultyAttributes, type HighStrainSection, type IDifficultyAttributes, type IDroidDifficultyAttributes, type IExtendedDroidDifficultyAttributes, type IOsuDifficultyAttributes, OsuAim, OsuAimEvaluator, OsuDifficultyAttributes, OsuDifficultyCalculator, OsuDifficultyHitObject, OsuFlashlight, OsuFlashlightEvaluator, OsuPerformanceCalculator, OsuRhythmEvaluator, OsuSpeed, OsuSpeedEvaluator, type PerformanceCalculationOptions, PerformanceCalculator, type StrainPeaks };
+export { type CacheableDifficultyAttributes, type DifficultSlider, DifficultyAttributes, DifficultyCalculator, DifficultyHitObject, DroidAim, DroidAimEvaluator, DroidDifficultyAttributes, DroidDifficultyCalculator, DroidDifficultyHitObject, DroidFlashlight, DroidFlashlightEvaluator, DroidPerformanceCalculator, DroidReading, DroidReadingEvaluator, DroidRhythm, DroidRhythmEvaluator, DroidTap, DroidTapEvaluator, ExtendedDroidDifficultyAttributes, type HighStrainSection, type IDifficultyAttributes, type IDroidDifficultyAttributes, type IExtendedDroidDifficultyAttributes, type IOsuDifficultyAttributes, OsuAim, OsuAimEvaluator, OsuDifficultyAttributes, OsuDifficultyCalculator, OsuDifficultyHitObject, OsuFlashlight, OsuFlashlightEvaluator, OsuPerformanceCalculator, OsuRhythmEvaluator, OsuSpeed, OsuSpeedEvaluator, type PerformanceCalculationOptions, PerformanceCalculator, type StrainPeaks };