diff --git a/osu.Game/Beatmaps/BeatmapDifficultyManager.cs b/osu.Game/Beatmaps/BeatmapDifficultyManager.cs
index bbd204dede..3a21df8aeb 100644
--- a/osu.Game/Beatmaps/BeatmapDifficultyManager.cs
+++ b/osu.Game/Beatmaps/BeatmapDifficultyManager.cs
@@ -317,11 +317,27 @@ namespace osu.Game.Beatmaps
public readonly struct StarDifficulty
{
+ ///
+ /// The star difficulty rating for the given beatmap.
+ ///
public readonly double Stars;
+
+ ///
+ /// The maximum combo achievable on the given beatmap.
+ ///
public readonly int MaxCombo;
+ ///
+ /// The difficulty attributes computed for the given beatmap.
+ /// Might not be available if the star difficulty is associated with a beatmap that's not locally available.
+ ///
+ [CanBeNull]
public readonly DifficultyAttributes Attributes;
+ ///
+ /// Creates a structure based on computed
+ /// by a .
+ ///
public StarDifficulty([NotNull] DifficultyAttributes attributes)
{
Stars = attributes.StarRating;
@@ -330,6 +346,10 @@ namespace osu.Game.Beatmaps
// Todo: Add more members (BeatmapInfo.DifficultyRating? Attributes? Etc...)
}
+ ///
+ /// Creates a structure with a pre-populated star difficulty and max combo
+ /// in scenarios where computing is not feasible (i.e. when working with online sources).
+ ///
public StarDifficulty(double starDifficulty, int maxCombo)
{
Stars = starDifficulty;