Move common song select implementation for online play

osu.Game/Screens/OnlinePlay/Multiplayer/MultiplayerMatchSongSelect.cs

@@ -1,25 +1,18 @@
 // 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 System.Collections.Generic;
-using System.Linq;
-using Humanizer;
 using osu.Framework.Allocation;
 using osu.Framework.Bindables;
 using osu.Framework.Extensions.Color4Extensions;
 using osu.Framework.Graphics;
-using osu.Framework.Graphics.Containers;
 using osu.Framework.Graphics.UserInterface;
 using osu.Framework.Logging;
 using osu.Framework.Screens;
-using osu.Game.Beatmaps;
 using osu.Game.Graphics;
 using osu.Game.Graphics.UserInterface;
 using osu.Game.Online.Multiplayer;
 using osu.Game.Online.Rooms;
-using osu.Game.Overlays.Mods;
-using osu.Game.Rulesets;
 using osu.Game.Rulesets.Mods;
 using osu.Game.Screens.Play.HUD;
 using osu.Game.Screens.Select;
@@ -27,67 +20,21 @@ using osuTK;
 
 namespace osu.Game.Screens.OnlinePlay.Multiplayer
 {
-    public class MultiplayerMatchSongSelect : SongSelect, IOnlinePlaySubScreen
+    public class MultiplayerMatchSongSelect : OnlinePlaySongSelect
     {
-        public string ShortTitle => "song selection";
-
-        public override string Title => ShortTitle.Humanize();
-
-        [Resolved(typeof(Room), nameof(Room.Playlist))]
-        private BindableList<PlaylistItem> playlist { get; set; }
-
         [Resolved]
         private StatefulMultiplayerClient client { get; set; }
 
-        private readonly Bindable<IReadOnlyList<Mod>> freeMods = new Bindable<IReadOnlyList<Mod>>(Array.Empty<Mod>());
-
-        private readonly FreeModSelectOverlay freeModSelectOverlay;
         private LoadingLayer loadingLayer;
 
-        private WorkingBeatmap initialBeatmap;
-        private RulesetInfo initialRuleset;
-        private IReadOnlyList<Mod> initialMods;
-
-        private bool itemSelected;
-
-        public MultiplayerMatchSongSelect()
-        {
-            Padding = new MarginPadding { Horizontal = HORIZONTAL_OVERFLOW_PADDING };
-
-            freeModSelectOverlay = new FreeModSelectOverlay
-            {
-                SelectedMods = { BindTarget = freeMods },
-                IsValidMod = isValidFreeMod,
-            };
-        }
-
         [BackgroundDependencyLoader]
         private void load()
         {
             AddInternal(loadingLayer = new LoadingLayer(true));
-            initialBeatmap = Beatmap.Value;
-            initialRuleset = Ruleset.Value;
-            initialMods = Mods.Value.ToList();
-
-            freeMods.Value = playlist.FirstOrDefault()?.AllowedMods.Select(m => m.CreateCopy()).ToArray() ?? Array.Empty<Mod>();
-
-            FooterPanels.Add(freeModSelectOverlay);
         }
 
-        protected override bool OnStart()
+        protected override void OnSetItem(PlaylistItem item)
         {
-            itemSelected = true;
-            var item = new PlaylistItem();
-
-            item.Beatmap.Value = Beatmap.Value.BeatmapInfo;
-            item.Ruleset.Value = Ruleset.Value;
-
-            item.RequiredMods.Clear();
-            item.RequiredMods.AddRange(Mods.Value.Select(m => m.CreateCopy()));
-
-            item.AllowedMods.Clear();
-            item.AllowedMods.AddRange(freeMods.Value.Select(m => m.CreateCopy()));
-
             // If the client is already in a room, update via the client.
             // Otherwise, update the playlist directly in preparation for it to be submitted to the API on match creation.
             if (client.Room != null)
@@ -112,43 +59,13 @@ namespace osu.Game.Screens.OnlinePlay.Multiplayer
             }
             else
             {
-                playlist.Clear();
+                Playlist.Clear();
-                playlist.Add(item);
+                Playlist.Add(item);
                 this.Exit();
             }
-
-            return true;
-        }
-
-        public override bool OnExiting(IScreen next)
-        {
-            if (!itemSelected)
-            {
-                Beatmap.Value = initialBeatmap;
-                Ruleset.Value = initialRuleset;
-                Mods.Value = initialMods;
-            }
-
-            return base.OnExiting(next);
         }
 
         protected override BeatmapDetailArea CreateBeatmapDetailArea() => new PlayBeatmapDetailArea();
-
-        protected override ModSelectOverlay CreateModSelectOverlay() => new SoloModSelectOverlay
-        {
-            IsValidMod = isValidMod
-        };
-
-        protected override IEnumerable<(FooterButton, OverlayContainer)> CreateFooterButtons()
-        {
-            var buttons = base.CreateFooterButtons().ToList();
-            buttons.Insert(buttons.FindIndex(b => b.Item1 is FooterButtonMods) + 1, (new FooterButtonFreeMods { Current = freeMods }, freeModSelectOverlay));
-            return buttons;
-        }
-
-        private bool isValidMod(Mod mod) => !(mod is ModAutoplay) && (mod as MultiMod)?.Mods.Any(mm => mm is ModAutoplay) != true;
-
-        private bool isValidFreeMod(Mod mod) => isValidMod(mod) && !(mod is ModRateAdjust) && !(mod is ModTimeRamp);
     }
 
     public class FooterButtonFreeMods : FooterButton, IHasCurrentValue<IReadOnlyList<Mod>>

osu.Game/Screens/OnlinePlay/OnlinePlaySongSelect.cs

@@ -0,0 +1,124 @@
+// 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 System.Collections.Generic;
+using System.Linq;
+using Humanizer;
+using osu.Framework.Allocation;
+using osu.Framework.Bindables;
+using osu.Framework.Graphics;
+using osu.Framework.Graphics.Containers;
+using osu.Framework.Screens;
+using osu.Game.Beatmaps;
+using osu.Game.Online.Rooms;
+using osu.Game.Overlays.Mods;
+using osu.Game.Rulesets;
+using osu.Game.Rulesets.Mods;
+using osu.Game.Screens.OnlinePlay.Multiplayer;
+using osu.Game.Screens.Select;
+
+namespace osu.Game.Screens.OnlinePlay
+{
+    public abstract class OnlinePlaySongSelect : SongSelect, IOnlinePlaySubScreen
+    {
+        public string ShortTitle => "song selection";
+
+        public override string Title => ShortTitle.Humanize();
+
+        public override bool AllowEditing => false;
+
+        [Resolved(typeof(Room), nameof(Room.Playlist))]
+        protected BindableList<PlaylistItem> Playlist { get; private set; }
+
+        private readonly Bindable<IReadOnlyList<Mod>> freeMods = new Bindable<IReadOnlyList<Mod>>(Array.Empty<Mod>());
+        private readonly FreeModSelectOverlay freeModSelectOverlay;
+
+        private WorkingBeatmap initialBeatmap;
+        private RulesetInfo initialRuleset;
+        private IReadOnlyList<Mod> initialMods;
+        private bool itemSelected;
+
+        protected OnlinePlaySongSelect()
+        {
+            Padding = new MarginPadding { Horizontal = HORIZONTAL_OVERFLOW_PADDING };
+
+            freeModSelectOverlay = new FreeModSelectOverlay
+            {
+                SelectedMods = { BindTarget = freeMods },
+                IsValidMod = IsValidFreeMod,
+            };
+        }
+
+        [BackgroundDependencyLoader]
+        private void load()
+        {
+            initialBeatmap = Beatmap.Value;
+            initialRuleset = Ruleset.Value;
+            initialMods = Mods.Value.ToList();
+
+            freeMods.Value = Playlist.FirstOrDefault()?.AllowedMods.Select(m => m.CreateCopy()).ToArray() ?? Array.Empty<Mod>();
+            FooterPanels.Add(freeModSelectOverlay);
+        }
+
+        protected sealed override bool OnStart()
+        {
+            itemSelected = true;
+
+            var item = new PlaylistItem();
+
+            item.Beatmap.Value = Beatmap.Value.BeatmapInfo;
+            item.Ruleset.Value = Ruleset.Value;
+
+            item.RequiredMods.Clear();
+            item.RequiredMods.AddRange(Mods.Value.Select(m => m.CreateCopy()));
+
+            item.AllowedMods.Clear();
+            item.AllowedMods.AddRange(freeMods.Value.Select(m => m.CreateCopy()));
+
+            OnSetItem(item);
+            return true;
+        }
+
+        protected abstract void OnSetItem(PlaylistItem item);
+
+        public override bool OnBackButton()
+        {
+            if (freeModSelectOverlay.State.Value == Visibility.Visible)
+            {
+                freeModSelectOverlay.Hide();
+                return true;
+            }
+
+            return base.OnBackButton();
+        }
+
+        public override bool OnExiting(IScreen next)
+        {
+            if (!itemSelected)
+            {
+                Beatmap.Value = initialBeatmap;
+                Ruleset.Value = initialRuleset;
+                Mods.Value = initialMods;
+            }
+
+            return base.OnExiting(next);
+        }
+
+        protected override ModSelectOverlay CreateModSelectOverlay() => new SoloModSelectOverlay
+        {
+            IsValidMod = IsValidMod
+        };
+
+        protected override IEnumerable<(FooterButton, OverlayContainer)> CreateFooterButtons()
+        {
+            var buttons = base.CreateFooterButtons().ToList();
+            buttons.Insert(buttons.FindIndex(b => b.Item1 is FooterButtonMods) + 1, (new FooterButtonFreeMods { Current = freeMods }, freeModSelectOverlay));
+            return buttons;
+        }
+
+        protected virtual bool IsValidMod(Mod mod) => !(mod is ModAutoplay) && (mod as MultiMod)?.Mods.Any(mm => mm is ModAutoplay) != true;
+
+        protected virtual bool IsValidFreeMod(Mod mod) => IsValidMod(mod);
+    }
+}

osu.Game/Screens/Select/MatchSongSelect.cs

@@ -1,48 +1,27 @@
 // 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 System.Linq;
-using Humanizer;
 using osu.Framework.Allocation;
-using osu.Framework.Bindables;
-using osu.Framework.Graphics;
 using osu.Framework.Screens;
 using osu.Game.Beatmaps;
 using osu.Game.Online.Rooms;
-using osu.Game.Overlays.Mods;
-using osu.Game.Rulesets.Mods;
 using osu.Game.Screens.OnlinePlay;
 using osu.Game.Screens.OnlinePlay.Components;
 
 namespace osu.Game.Screens.Select
 {
-    public class MatchSongSelect : SongSelect, IOnlinePlaySubScreen
+    public class MatchSongSelect : OnlinePlaySongSelect
     {
-        public Action<PlaylistItem> Selected;
-
-        public string ShortTitle => "song selection";
-        public override string Title => ShortTitle.Humanize();
-
-        public override bool AllowEditing => false;
-
-        [Resolved(typeof(Room), nameof(Room.Playlist))]
-        protected BindableList<PlaylistItem> Playlist { get; private set; }
-
         [Resolved]
         private BeatmapManager beatmaps { get; set; }
 
-        public MatchSongSelect()
-        {
-            Padding = new MarginPadding { Horizontal = HORIZONTAL_OVERFLOW_PADDING };
-        }
-
         protected override BeatmapDetailArea CreateBeatmapDetailArea() => new MatchBeatmapDetailArea
         {
             CreateNewItem = createNewItem
         };
 
-        protected override bool OnStart()
+        protected override void OnSetItem(PlaylistItem item)
         {
             switch (Playlist.Count)
             {
@@ -56,8 +35,6 @@ namespace osu.Game.Screens.Select
             }
 
             this.Exit();
-
-            return true;
         }
 
         private void createNewItem()
@@ -80,12 +57,5 @@ namespace osu.Game.Screens.Select
             item.RequiredMods.Clear();
             item.RequiredMods.AddRange(Mods.Value.Select(m => m.CreateCopy()));
         }
-
-        protected override ModSelectOverlay CreateModSelectOverlay() => new SoloModSelectOverlay
-        {
-            IsValidMod = isValidMod
-        };
-
-        private bool isValidMod(Mod mod) => !(mod is ModAutoplay) && (mod as MultiMod)?.Mods.Any(mm => mm is ModAutoplay) != true;
     }
 }