mirror of
https://github.com/ppy/osu.git
synced 2024-09-22 06:47:24 +08:00
111 lines
4.3 KiB
C#
111 lines
4.3 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.Collections.Generic;
|
|
using System.Threading.Tasks;
|
|
using osu.Game.Online.API;
|
|
using osu.Game.Online.Rooms;
|
|
|
|
namespace osu.Game.Online.Multiplayer
|
|
{
|
|
/// <summary>
|
|
/// An interface defining a multiplayer client instance.
|
|
/// </summary>
|
|
public interface IMultiplayerClient
|
|
{
|
|
/// <summary>
|
|
/// Signals that the room has changed state.
|
|
/// </summary>
|
|
/// <param name="state">The state of the room.</param>
|
|
Task RoomStateChanged(MultiplayerRoomState state);
|
|
|
|
/// <summary>
|
|
/// Signals that a user has joined the room.
|
|
/// </summary>
|
|
/// <param name="user">The user.</param>
|
|
Task UserJoined(MultiplayerRoomUser user);
|
|
|
|
/// <summary>
|
|
/// Signals that a user has left the room.
|
|
/// </summary>
|
|
/// <param name="user">The user.</param>
|
|
Task UserLeft(MultiplayerRoomUser user);
|
|
|
|
/// <summary>
|
|
/// Signals that a user has been kicked from the room.
|
|
/// </summary>
|
|
/// <remarks>
|
|
/// This will also be sent to the user that was kicked.
|
|
/// </remarks>
|
|
/// <param name="user">The user.</param>
|
|
Task UserKicked(MultiplayerRoomUser user);
|
|
|
|
/// <summary>
|
|
/// Signal that the host of the room has changed.
|
|
/// </summary>
|
|
/// <param name="userId">The user ID of the new host.</param>
|
|
Task HostChanged(int userId);
|
|
|
|
/// <summary>
|
|
/// Signals that the settings for this room have changed.
|
|
/// </summary>
|
|
/// <param name="newSettings">The updated room settings.</param>
|
|
Task SettingsChanged(MultiplayerRoomSettings newSettings);
|
|
|
|
/// <summary>
|
|
/// Signals that a user in this room changed their state.
|
|
/// </summary>
|
|
/// <param name="userId">The ID of the user performing a state change.</param>
|
|
/// <param name="state">The new state of the user.</param>
|
|
Task UserStateChanged(int userId, MultiplayerUserState state);
|
|
|
|
/// <summary>
|
|
/// Signals that the match type state has changed for a user in this room.
|
|
/// </summary>
|
|
/// <param name="userId">The ID of the user performing a state change.</param>
|
|
/// <param name="state">The new state of the user.</param>
|
|
Task MatchUserStateChanged(int userId, MatchUserState state);
|
|
|
|
/// <summary>
|
|
/// Signals that the match type state has changed for this room.
|
|
/// </summary>
|
|
/// <param name="state">The new state of the room.</param>
|
|
Task MatchRoomStateChanged(MatchRoomState state);
|
|
|
|
/// <summary>
|
|
/// Send a match type specific request.
|
|
/// </summary>
|
|
/// <param name="e">The event to handle.</param>
|
|
Task MatchEvent(MatchServerEvent e);
|
|
|
|
/// <summary>
|
|
/// Signals that a user in this room changed their beatmap availability state.
|
|
/// </summary>
|
|
/// <param name="userId">The ID of the user whose beatmap availability state has changed.</param>
|
|
/// <param name="beatmapAvailability">The new beatmap availability state of the user.</param>
|
|
Task UserBeatmapAvailabilityChanged(int userId, BeatmapAvailability beatmapAvailability);
|
|
|
|
/// <summary>
|
|
/// Signals that a user in this room changed their local mods.
|
|
/// </summary>
|
|
/// <param name="userId">The ID of the user whose mods have changed.</param>
|
|
/// <param name="mods">The user's new local mods.</param>
|
|
Task UserModsChanged(int userId, IEnumerable<APIMod> mods);
|
|
|
|
/// <summary>
|
|
/// 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();
|
|
|
|
/// <summary>
|
|
/// Signals that a match has started. All users in the <see cref="MultiplayerUserState.Loaded"/> state should begin gameplay as soon as possible.
|
|
/// </summary>
|
|
Task MatchStarted();
|
|
|
|
/// <summary>
|
|
/// Signals that the match has ended, all players have finished and results are ready to be displayed.
|
|
/// </summary>
|
|
Task ResultsReady();
|
|
}
|
|
}
|