sim1222/osukey
1
1
Fork 0
mirror of https://github.com/osukey/osukey.git synced 2025-05-08 23:27:38 +09:00
Code Issues Packages Projects Releases Wiki Activity

Add missing exceptions to server xmldoc

Browse Source
This commit is contained in:
Dean Herbert 2020-12-09 12:05:50 +09:00
parent ff5150a14d
commit 2046cbe2d9
1 changed files with 6 additions and 0 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

6
osu.Game/Online/RealtimeMultiplayer/IMultiplayerServer.cs
View File

@ -17,6 +17,7 @@ namespace osu.Game.Online.RealtimeMultiplayer
/// <summary> /// <summary>
/// Request to leave the currently joined room. /// Request to leave the currently joined room.
/// </summary> /// </summary>
/// <exception cref="NotJoinedRoomException">If the user is not in a room.</exception>
Task LeaveRoom(); Task LeaveRoom();
/// <summary> /// <summary>
@ -24,12 +25,15 @@ namespace osu.Game.Online.RealtimeMultiplayer
/// </summary> /// </summary>
/// <param name="userId">The new user which is to become host.</param> /// <param name="userId">The new user which is to become host.</param>
/// <exception cref="NotHostException">A user other than the current host is attempting to transfer host.</exception> /// <exception cref="NotHostException">A user other than the current host is attempting to transfer host.</exception>
/// <exception cref="NotJoinedRoomException">If the user is not in a room.</exception>
Task TransferHost(long userId); Task TransferHost(long userId);
/// <summary> /// <summary>
/// As the host, update the settings of the currently joined room. /// As the host, update the settings of the currently joined room.
/// </summary> /// </summary>
/// <param name="settings">The new settings to apply.</param> /// <param name="settings">The new settings to apply.</param>
/// <exception cref="NotHostException">A user other than the current host is attempting to transfer host.</exception>
/// <exception cref="NotJoinedRoomException">If the user is not in a room.</exception>
Task ChangeSettings(MultiplayerRoomSettings settings); Task ChangeSettings(MultiplayerRoomSettings settings);
/// <summary> /// <summary>
@ -37,12 +41,14 @@ namespace osu.Game.Online.RealtimeMultiplayer
/// </summary> /// </summary>
/// <param name="newState">The proposed new state.</param> /// <param name="newState">The proposed new state.</param>
/// <exception cref="InvalidStateChange">If the state change requested is not valid, given the previous state or room state.</exception> /// <exception cref="InvalidStateChange">If the state change requested is not valid, given the previous state or room state.</exception>
/// <exception cref="NotJoinedRoomException">If the user is not in a room.</exception>
Task ChangeState(MultiplayerUserState newState); Task ChangeState(MultiplayerUserState newState);
/// <summary> /// <summary>
/// As the host of a room, start the match. /// As the host of a room, start the match.
/// </summary> /// </summary>
/// <exception cref="NotHostException">A user other than the current host is attempting to start the game.</exception> /// <exception cref="NotHostException">A user other than the current host is attempting to start the game.</exception>
/// <exception cref="NotJoinedRoomException">If the user is not in a room.</exception>
Task StartMatch(); Task StartMatch();
} }
} }