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

Add note about LoadRequested only being sent to a subset of room users

Browse Source
This commit is contained in:
Dean Herbert 2020-12-08 19:44:22 +09:00
parent 021a116093
commit d76fabedf9
2 changed files with 5 additions and 1 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

2
osu.Game/Online/RealtimeMultiplayer/IMultiplayerClient.cs
View File

@ -48,7 +48,7 @@ namespace osu.Game.Online.RealtimeMultiplayer
Task UserStateChanged(long userId, MultiplayerUserState state);
/// <summary>
/// Signals that a match is to be started. Users in the <see cref="MultiplayerUserState.Ready"/> state should begin loading gameplay at this point.
/// Signals that a match is to be started. This will *only* be sent to clients which are to begin loading at this point.
/// </summary>
Task LoadRequested();

4
osu.Game/Online/RealtimeMultiplayer/MultiplayerUserState.cs
View File

@ -13,6 +13,10 @@ namespace osu.Game.Online.RealtimeMultiplayer
/// <summary>
/// The user has marked themselves as ready to participate and should be considered for the next game start.
/// </summary>
/// <remarks>
/// Clients in this state will receive gameplay channel messages.
/// As a client the only thing to look for in this state is a <see cref="IMultiplayerClient.LoadRequested"/> call.
/// </remarks>
Ready,
/// <summary>