You signed in with another tab or window. Reload to refresh your session.You signed out in another tab or window. Reload to refresh your session.You switched accounts on another tab or window. Reload to refresh your session.Dismiss alert
Copy file name to clipboardExpand all lines: osu.Game/Rulesets/Difficulty/DifficultyCalculator.cs
+12-4Lines changed: 12 additions & 4 deletions
Original file line number
Diff line number
Diff line change
@@ -94,6 +94,9 @@ public DifficultyAttributes Calculate([NotNull] IEnumerable<Mod> mods, Cancellat
94
94
/// <summary>
95
95
/// Calculates the difficulty of the beatmap with no mods applied and returns a set of <see cref="TimedDifficultyAttributes"/> representing the difficulty at every relevant time value in the beatmap.
96
96
/// </summary>
97
+
/// <remarks>
98
+
/// Unless a <paramref name="cancellationToken"/> is specified, calculation times out after 10 seconds.
@@ -102,12 +105,15 @@ public List<TimedDifficultyAttributes> CalculateTimed(CancellationToken cancella
102
105
/// <summary>
103
106
/// Calculates the difficulty of the beatmap using a specific mod combination and returns a set of <see cref="TimedDifficultyAttributes"/> representing the difficulty at every relevant time value in the beatmap.
104
107
/// </summary>
108
+
/// <remarks>
109
+
/// Unless a <paramref name="cancellationToken"/> is specified, calculation times out after 10 seconds.
110
+
/// </remarks>
105
111
/// <param name="mods">The mods that should be applied to the beatmap.</param>
/// Lazily calculates the difficulty of the beatmap on-demand using a specific mod combination and yields <see cref="TimedDifficultyAttributes"/> representing the difficulty until every relevant time value in the beatmap.
127
133
/// </summary>
128
134
/// <remarks>
129
-
/// Preprocessing is done before this method returns.
135
+
/// 1. Preprocessing is done before this method returns.<br />
136
+
/// 2. Cancelling the <paramref name="cancellationToken"/> will throw while enumerating.
130
137
/// </remarks>
131
138
/// <param name="mods">The mods that should be applied to the beatmap.</param>
0 commit comments