mirror of
https://github.com/ppy/osu.git
synced 2024-11-20 02:13:01 +08:00
0d5fbb15ac
Default value restated in xmldoc was snipped because it's made redundant by the initialiser and possibly bound to be outdated at some point.
59 lines
2.8 KiB
C#
59 lines
2.8 KiB
C#
// Copyright (c) ppy Pty Ltd <contact@ppy.sh>. Licensed under the MIT Licence.
|
|
// See the LICENCE file in the repository root for full licence text.
|
|
|
|
using System.Threading.Tasks;
|
|
using osu.Game.Online.Rooms;
|
|
|
|
namespace osu.Game.Online.Multiplayer
|
|
{
|
|
/// <summary>
|
|
/// Interface for an in-room multiplayer server.
|
|
/// </summary>
|
|
public interface IMultiplayerRoomServer
|
|
{
|
|
/// <summary>
|
|
/// Request to leave the currently joined room.
|
|
/// </summary>
|
|
/// <exception cref="NotJoinedRoomException">If the user is not in a room.</exception>
|
|
Task LeaveRoom();
|
|
|
|
/// <summary>
|
|
/// Transfer the host of the currently joined room to another user in the room.
|
|
/// </summary>
|
|
/// <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="NotJoinedRoomException">If the user is not in a room.</exception>
|
|
Task TransferHost(int userId);
|
|
|
|
/// <summary>
|
|
/// As the host, update the settings of the currently joined room.
|
|
/// </summary>
|
|
/// <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);
|
|
|
|
/// <summary>
|
|
/// Change the local user state in the currently joined room.
|
|
/// </summary>
|
|
/// <param name="newState">The proposed new state.</param>
|
|
/// <exception cref="InvalidStateChangeException">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);
|
|
|
|
/// <summary>
|
|
/// Change the local user's availability state of the current beatmap set in joined room.
|
|
/// </summary>
|
|
/// <param name="newBeatmapAvailability">The proposed new beatmap availability state.</param>
|
|
Task ChangeBeatmapAvailability(BeatmapAvailability newBeatmapAvailability);
|
|
|
|
/// <summary>
|
|
/// As the host of a room, start the match.
|
|
/// </summary>
|
|
/// <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>
|
|
/// <exception cref="InvalidStateException">If an attempt to start the game occurs when the game's (or users') state disallows it.</exception>
|
|
Task StartMatch();
|
|
}
|
|
}
|