h1or4dme8/osu-lazer
1
0
Fork 0
mirror of https://github.com/ppy/osu.git synced 2025-03-21 18:47:20 +08:00
Code Issues Releases Wiki Activity

Merge pull request #15949 from peppy/playlist-order-documentation

Browse Source 
Reword xmldoc of `MultiplayerPlaylistItem.PlaylistOrder` to better match actual behaviour
This commit is contained in:
Dan Balasescu 2021-12-06 13:28:11 +09:00 committed by GitHub
commit ffbab0014b
No known key found for this signature in database
GPG Key ID: 4AEE18F83AFDEB23
1 changed files with 5 additions and 1 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

6
osu.Game/Online/Rooms/MultiplayerPlaylistItem.cs
View File

@ -40,8 +40,12 @@ namespace osu.Game.Online.Rooms
public bool Expired { get; set; }
/// <summary>
/// The order in which this <see cref="MultiplayerPlaylistItem"/> will be played, starting from 0 and increasing for items which will be played later.
/// The order in which this <see cref="MultiplayerPlaylistItem"/> will be played relative to others.
/// Playlist items should be played in increasing order (lower values are played first).
/// </summary>
/// <remarks>
/// This is only valid for items which are not <see cref="Expired"/>. The value for expired items is undefined and should not be used.
/// </remarks>
[Key(8)]
public ushort PlaylistOrder { get; set; }