osu-lazer/osu.Game/Tests/Visual/Multiplayer/MultiplayerTestScene.cs

// 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.Game.Online.Rooms;
using osu.Game.Tests.Beatmaps;
using osu.Game.Tests.Visual.OnlinePlay;
using osu.Game.Tests.Visual.Spectator;

namespace osu.Game.Tests.Visual.Multiplayer
{
    /// <summary>
    /// The base test scene for all multiplayer components and screens.
    /// </summary>
    public abstract partial class MultiplayerTestScene : OnlinePlayTestScene, IMultiplayerTestSceneDependencies
    {
        public const int PLAYER_1_ID = 55;
        public const int PLAYER_2_ID = 56;

        public TestMultiplayerClient MultiplayerClient => OnlinePlayDependencies.MultiplayerClient;
        public TestSpectatorClient SpectatorClient => OnlinePlayDependencies.SpectatorClient;

        protected new MultiplayerTestSceneDependencies OnlinePlayDependencies => (MultiplayerTestSceneDependencies)base.OnlinePlayDependencies;

        public bool RoomJoined => MultiplayerClient.RoomJoined;

        /// <summary>
        /// Creates and joins a basic multiplayer room.
        /// </summary>
        /// <param name="setupFunc">A callback that may be used to further set up the room.</param>
        protected void JoinDefaultRoom(Action<Room>? setupFunc = null)
        {
            AddStep("join room", () =>
            {
                Room room = new Room
                {
                    Name = "test name",
                    Type = MatchType.HeadToHead,
                    Playlist =
                    [
                        new PlaylistItem(new TestBeatmap(Ruleset.Value).BeatmapInfo)
                        {
                            RulesetID = Ruleset.Value.OnlineID
                        }
                    ]
                };

                setupFunc?.Invoke(room);

                MultiplayerClient.CreateRoom(room).ConfigureAwait(false);
            });

            AddUntilStep("wait for room join", () => RoomJoined);
        }

        protected override OnlinePlayTestSceneDependencies CreateOnlinePlayDependencies() => new MultiplayerTestSceneDependencies();
    }
}