RepoMirrors/osu
1
0
Fork 0
mirror of https://github.com/ppy/osu synced 2025-01-11 08:39:31 +00:00
Code Issues Packages Projects Releases Wiki Activity

Add xmldoc for CreateScoreInfo function for now

Browse Source 
I don't actually know how temporary this one is going to be. The usages
are quite deep - ie. converting to a `ScoreInfo` to get a calculated
total score for ordering purposes.
This commit is contained in:
Dean Herbert 2021-10-29 14:51:06 +09:00
parent f68d6dbc8f
commit 06b6bcfd29
1 changed files with 6 additions and 1 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

7
osu.Game/Online/API/Requests/Responses/APIScoreInfo.cs
View File

@ -70,7 +70,12 @@ namespace osu.Game.Online.API.Requests.Responses
[JsonConverter(typeof(StringEnumConverter))]
public ScoreRank Rank { get; set; }
// TODO: This function will eventually be going away.
/// <summary>
/// Create a <see cref="ScoreInfo"/> from an API score instance.
/// </summary>
/// <param name="rulesets">A ruleset store, used to populate a ruleset instance in the returned score.</param>
/// <param name="beatmap">An optional beatmap, copied into the returned score (for cases where the API does not populate the beatmap).</param>
/// <returns></returns>
public ScoreInfo CreateScoreInfo(RulesetStore rulesets, BeatmapInfo beatmap = null)
{
var ruleset = rulesets.GetRuleset(OnlineRulesetID);