Add remark about usage of CalculateAll()

This commit is contained in:
Dan Balasescu 2022-02-22 18:12:55 +09:00
parent 567da9214e
commit bedd07d2e4

View File

@ -120,6 +120,9 @@ namespace osu.Game.Rulesets.Difficulty
/// <summary>
/// Calculates the difficulty of the beatmap using all mod combinations applicable to the beatmap.
/// </summary>
/// <remarks>
/// This should only be used to compute difficulties for legacy mod combinations.
/// </remarks>
/// <returns>A collection of structures describing the difficulty of the beatmap for each mod combination.</returns>
public IEnumerable<DifficultyAttributes> CalculateAll(CancellationToken cancellationToken = default)
{