mirror of
https://github.com/ppy/osu.git
synced 2024-11-14 10:57:30 +08:00
51 lines
1.8 KiB
C#
51 lines
1.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;
|
|
using osu.Framework.Allocation;
|
|
using osu.Framework.Bindables;
|
|
using osu.Game.Online.Rooms;
|
|
|
|
namespace osu.Game.Screens.OnlinePlay
|
|
{
|
|
[Cached(typeof(IRoomManager))]
|
|
public interface IRoomManager
|
|
{
|
|
/// <summary>
|
|
/// Invoked when the <see cref="Room"/>s have been updated.
|
|
/// </summary>
|
|
event Action RoomsUpdated;
|
|
|
|
/// <summary>
|
|
/// Whether an initial listing of rooms has been received.
|
|
/// </summary>
|
|
IBindable<bool> InitialRoomsReceived { get; }
|
|
|
|
/// <summary>
|
|
/// All the active <see cref="Room"/>s.
|
|
/// </summary>
|
|
IBindableList<Room> Rooms { get; }
|
|
|
|
/// <summary>
|
|
/// Creates a new <see cref="Room"/>.
|
|
/// </summary>
|
|
/// <param name="room">The <see cref="Room"/> to create.</param>
|
|
/// <param name="onSuccess">An action to be invoked if the creation succeeds.</param>
|
|
/// <param name="onError">An action to be invoked if an error occurred.</param>
|
|
void CreateRoom(Room room, Action<Room> onSuccess = null, Action<string> onError = null);
|
|
|
|
/// <summary>
|
|
/// Joins a <see cref="Room"/>.
|
|
/// </summary>
|
|
/// <param name="room">The <see cref="Room"/> to join. <see cref="Room.RoomID"/> must be populated.</param>
|
|
/// <param name="onSuccess"></param>
|
|
/// <param name="onError"></param>
|
|
void JoinRoom(Room room, Action<Room> onSuccess = null, Action<string> onError = null);
|
|
|
|
/// <summary>
|
|
/// Parts the currently-joined <see cref="Room"/>.
|
|
/// </summary>
|
|
void PartRoom();
|
|
}
|
|
}
|