mirror of
https://github.com/ppy/osu.git
synced 2026-06-03 15:04:26 +08:00
Dan Balasescu
c72b6412ea
Rebase of https://github.com/smoogipoo/osu/pull/193 Going forward, the client will have to know the type of pool being invited to so that it can enter the appropriate screen when clicking the notification. Unfortunately, SignalR does not support overloading methods, or even adding parameters to them, so this PR deprecates the `MatchmakingRoomInvited` event and adds its replacement `MatchmakingRoomInvitedWithParams` with a complex `invitation` parameter that we _can_ extend in the future if required (such as potentially adding the name of the pool). This also prepares the notification by extracting some code to a `Complete` method receiving said `invitation` parameter. This part of code will be further modified to enter the correct screen: https://github.com/smoogipoo/osu/blob/0a4018045b9d908f66c63dee65d0059d05b26e43/osu.Game/Screens/OnlinePlay/Matchmaking/Queue/QueueController.cs#L200 In particular, I have tested that new clients continue to work with the old server (dev.ppy.sh) in quick play | | Old Server | New Server | | ------------- |:-------------:| :-----:| | Old Client | 🟢 | 🟢 | | New Client | 🟢 | 🟢 |
69 lines
3.0 KiB
C#
69 lines
3.0 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;
|
|
|
|
namespace osu.Game.Online.Matchmaking
|
|
{
|
|
public interface IMatchmakingClient : IStatefulUserHubClient
|
|
{
|
|
/// <summary>
|
|
/// Signals that the local user was placed in the matchmaking queue.
|
|
/// </summary>
|
|
Task MatchmakingQueueJoined();
|
|
|
|
/// <summary>
|
|
/// Signals that the local user was removed from the matchmaking queue.
|
|
/// </summary>
|
|
Task MatchmakingQueueLeft();
|
|
|
|
/// <summary>
|
|
/// Signals that a match has been found and the local user is invited to it.
|
|
/// The invitation may be <see cref="IMatchmakingServer.MatchmakingAcceptInvitation">accepted</see>,
|
|
/// <see cref="IMatchmakingServer.MatchmakingDeclineInvitation">declined</see>,
|
|
/// or ignored - in which case it will automatically be declined after a short timeout period.
|
|
/// </summary>
|
|
/// <remarks>
|
|
/// Provided for compatibility with older clients - can be removed 20260825.
|
|
/// </remarks>
|
|
Task MatchmakingRoomInvited();
|
|
|
|
/// <summary>
|
|
/// Signals that a match has been found and the local user is invited to it.
|
|
/// The invitation may be <see cref="IMatchmakingServer.MatchmakingAcceptInvitation">accepted</see>,
|
|
/// <see cref="IMatchmakingServer.MatchmakingDeclineInvitation">declined</see>,
|
|
/// or ignored - in which case it will automatically be declined after a short timeout period.
|
|
/// </summary>
|
|
Task MatchmakingRoomInvitedWithParams(MatchmakingRoomInvitationParams invitation);
|
|
|
|
/// <summary>
|
|
/// Signals that the matchmaking room is ready to be opened.
|
|
/// </summary>
|
|
Task MatchmakingRoomReady(long roomId, string password);
|
|
|
|
/// <summary>
|
|
/// The matchmaking lobby status has changed.
|
|
/// </summary>
|
|
Task MatchmakingLobbyStatusChanged(MatchmakingLobbyStatus status);
|
|
|
|
/// <summary>
|
|
/// The matchmaking status of the current user has changed.
|
|
/// </summary>
|
|
Task MatchmakingQueueStatusChanged(MatchmakingQueueStatus status);
|
|
|
|
/// <summary>
|
|
/// The user has raised a candidate playlist item to be played.
|
|
/// </summary>
|
|
/// <param name="userId">The notifying user.</param>
|
|
/// <param name="playlistItemId">The playlist item candidate raised, or -1 as a special value that indicates a random selection.</param>
|
|
Task MatchmakingItemSelected(int userId, long playlistItemId);
|
|
|
|
/// <summary>
|
|
/// The user has removed a candidate playlist item.
|
|
/// </summary>
|
|
/// <param name="userId">The notifying user.</param>
|
|
/// <param name="playlistItemId">The playlist item candidate removed, or -1 as a special value that indicates a random selection.</param>
|
|
Task MatchmakingItemDeselected(int userId, long playlistItemId);
|
|
}
|
|
}
|