h1or4dme8/osu-lazer
1
0
Fork 0
mirror of https://github.com/ppy/osu.git synced 2024-11-08 00:37:40 +08:00
Code Issues Releases Wiki Activity

Reword xmldoc to read better

Browse Source
This commit is contained in:
Dean Herbert 2023-02-08 14:20:58 +09:00
parent 086b3eb542
commit 5c113ddb03
1 changed files with 12 additions and 9 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

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

@ -23,11 +23,8 @@ using Realms;
namespace osu.Game.Scoring
{
/// <summary>
/// Store information about the score
/// A realm model containing metadata for a single score.
/// </summary>
/// <remarks>
/// Warning: If you work on importing/adding score please ensure you provide both <c>BeatmapInfo</c> and <c>BeatmapHash</c>
/// </remarks>
[ExcludeFromDynamicCompile]
[MapTo("Score")]
public class ScoreInfo : RealmObject, IHasGuidPrimaryKey, IHasRealmFiles, ISoftDelete, IEquatable<ScoreInfo>, IScoreInfo
@ -35,8 +32,19 @@ namespace osu.Game.Scoring
[PrimaryKey]
public Guid ID { get; set; }
/// <summary>
/// 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.
/// </remarks>
public BeatmapInfo BeatmapInfo { get; set; } = null!;
/// <summary>
/// The <see cref="BeatmapInfo.Hash"/> at the point in time when the score was set.
/// </summary>
public string BeatmapHash { get; set; } = string.Empty;
public RulesetInfo Ruleset { get; set; } = null!;
public IList<RealmNamedFileUsage> Files { get; } = null!;
@ -72,11 +80,6 @@ namespace osu.Game.Scoring
[MapTo("MaximumStatistics")]
public string MaximumStatisticsJson { get; set; } = string.Empty;
/// <summary>
/// The <see cref="Beatmaps.BeatmapInfo"/>.Hash at the point in time when the score was set.
/// </summary>
public string BeatmapHash { get; set; } = string.Empty;
public ScoreInfo(BeatmapInfo? beatmap = null, RulesetInfo? ruleset = null, RealmUser? realmUser = null)
{
Ruleset = ruleset ?? new RulesetInfo();