h1or4dme8/osu-lazer
1
0
Fork 0
mirror of https://github.com/ppy/osu.git synced 2025-01-27 00:23:01 +08:00
Code Issues Releases Wiki Activity

Expand ScoreInfo.BeatmapInfo xmldoc

Browse Source
This commit is contained in:
Bartłomiej Dach 2023-07-04 22:20:50 +02:00
parent a0bed0fcec
commit a55809733d
No known key found for this signature in database
1 changed files with 8 additions and 1 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

9
osu.Game/Scoring/ScoreInfo.cs
View File

@ -34,7 +34,14 @@ namespace osu.Game.Scoring
/// The <see cref="BeatmapInfo"/> this score was made against.
/// </summary>
/// <remarks>
/// When setting this, make sure to also set <see cref="BeatmapHash"/> to allow relational consistency when a beatmap is potentially changed.
/// <para>
/// This property may be <see langword="null"/> if the score was set on a beatmap (or a version of the beatmap) that is not available locally
/// e.g. due to online updates, or local modifications to the beatmap.
/// The property will only link to a <see cref="BeatmapInfo"/> if its <see cref="Beatmaps.BeatmapInfo.Hash"/> matches <see cref="BeatmapHash"/>.
/// </para>
/// <para>
/// Due to the above, whenever setting this, make sure to also set <see cref="BeatmapHash"/> to allow relational consistency when a beatmap is potentially changed.
/// </para>
/// </remarks>
public BeatmapInfo? BeatmapInfo { get; set; }