1
0
mirror of https://github.com/ppy/osu.git synced 2024-09-21 18:47:27 +08:00

Move lower and xmldoc GetFilename(TModel)

This commit is contained in:
Bartłomiej Dach 2023-05-06 19:29:08 +02:00
parent 5e64d25b2a
commit e0823ffd03
No known key found for this signature in database

View File

@ -41,7 +41,6 @@ namespace osu.Game.Database
protected readonly Storage UserFileStorage;
private readonly Storage exportStorage;
protected virtual string GetFilename(TModel item) => item.GetDisplayString();
public Action<Notification>? PostNotification { get; set; }
@ -51,6 +50,16 @@ namespace osu.Game.Database
UserFileStorage = storage.GetStorageForDirectory(@"files");
}
/// <summary>
/// Returns the baseline name of the file to which the <paramref name="item"/> will be exported.
/// </summary>
/// <remarks>
/// The name of the file will be run through <see cref="ModelExtensions.GetValidFilename"/> to eliminate characters
/// which are not permitted by various filesystems.
/// </remarks>
/// <param name="item">The item being exported.</param>
protected virtual string GetFilename(TModel item) => item.GetDisplayString();
/// <summary>
/// Exports a model to the default export location.
/// This will create a notification tracking the progress of the export, visible to the user.