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

Fill out ICreateReplayData xmldocs

Browse Source
This commit is contained in:
Bartłomiej Dach 2022-03-30 22:02:51 +02:00
parent 9621a7f9cb
commit 83bae81095
No known key found for this signature in database
GPG Key ID: BCECCD4FA41F6497
1 changed files with 8 additions and 3 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

11
osu.Game/Rulesets/Mods/ICreateReplayData.cs
View File

@ -5,6 +5,7 @@ using System.Collections.Generic;
using osu.Game.Beatmaps;
using osu.Game.Online.API.Requests.Responses;
using osu.Game.Replays;
using osu.Game.Scoring;
using osu.Game.Users;
namespace osu.Game.Rulesets.Mods
@ -17,9 +18,13 @@ namespace osu.Game.Rulesets.Mods
/// <summary>
/// Create replay data.
/// </summary>
/// <param name="beatmap"></param>
/// <param name="mods"></param>
/// <returns></returns>
/// <param name="beatmap">The beatmap to create replay data for.</param>
/// <param name="mods">The mods to take into account when creating the replay data.</param>
/// <returns>A <see cref="ModReplayData"/> structure, containing the generated replay data.</returns>
/// <remarks>
/// For callers that want to receive a directly usable <see cref="Score"/> instance,
/// the <see cref="ModExtensions.CreateScoreFromReplayData"/> extension method is provided for convenience.
/// </remarks>
public ModReplayData CreateReplayData(IBeatmap beatmap, IReadOnlyList<Mod> mods);
}