Merge pull request #22801 from cdwcgt/edit-mods-preset

Add ability to edit mod presets

osu.Game.Tests/Visual/UserInterface/TestSceneModPresetColumn.cs

@@ -243,7 +243,7 @@ namespace osu.Game.Tests.Visual.UserInterface
             AddUntilStep("wait for context menu", () => this.ChildrenOfType<OsuContextMenu>().Any());
             AddStep("click delete", () =>
             {
-                var deleteItem = this.ChildrenOfType<DrawableOsuMenuItem>().Single();
+                var deleteItem = this.ChildrenOfType<DrawableOsuMenuItem>().ElementAt(1);
                 InputManager.MoveMouseTo(deleteItem);
                 InputManager.Click(MouseButton.Left);
             });
@@ -261,6 +261,137 @@ namespace osu.Game.Tests.Visual.UserInterface
             AddAssert("preset soft-deleted", () => Realm.Run(r => r.All<ModPreset>().Count(preset => preset.DeletePending) == 1));
         }
 
+        [Test]
+        public void TestEditPresetName()
+        {
+            ModPresetColumn modPresetColumn = null!;
+            string presetName = null!;
+            ModPresetPanel panel = null!;
+
+            AddStep("clear mods", () => SelectedMods.Value = Array.Empty<Mod>());
+            AddStep("create content", () => Child = modPresetColumn = new ModPresetColumn
+            {
+                Anchor = Anchor.Centre,
+                Origin = Anchor.Centre,
+            });
+
+            AddUntilStep("items loaded", () => modPresetColumn.IsLoaded && modPresetColumn.ItemsLoaded);
+            AddStep("right click first panel", () =>
+            {
+                panel = this.ChildrenOfType<ModPresetPanel>().First();
+                presetName = panel.Preset.Value.Name;
+                InputManager.MoveMouseTo(panel);
+                InputManager.Click(MouseButton.Right);
+            });
+
+            AddUntilStep("wait for context menu", () => this.ChildrenOfType<OsuContextMenu>().Any());
+            AddStep("click edit", () =>
+            {
+                var editItem = this.ChildrenOfType<DrawableOsuMenuItem>().ElementAt(0);
+                InputManager.MoveMouseTo(editItem);
+                InputManager.Click(MouseButton.Left);
+            });
+
+            OsuPopover? popover = null;
+            AddUntilStep("wait for popover", () => (popover = this.ChildrenOfType<OsuPopover>().FirstOrDefault()) != null);
+            AddStep("clear preset name", () => popover.ChildrenOfType<LabelledTextBox>().First().Current.Value = "");
+            AddStep("attempt preset edit", () =>
+            {
+                InputManager.MoveMouseTo(popover.ChildrenOfType<ShearedButton>().ElementAt(1));
+                InputManager.Click(MouseButton.Left);
+            });
+
+            AddAssert("preset is not changed", () => panel.Preset.Value.Name == presetName);
+            AddUntilStep("popover is unchanged", () => this.ChildrenOfType<OsuPopover>().FirstOrDefault() == popover);
+            AddStep("edit preset name", () => popover.ChildrenOfType<LabelledTextBox>().First().Current.Value = "something new");
+            AddStep("attempt preset edit", () =>
+            {
+                InputManager.MoveMouseTo(popover.ChildrenOfType<ShearedButton>().ElementAt(1));
+                InputManager.Click(MouseButton.Left);
+            });
+            AddUntilStep("popover closed", () => !this.ChildrenOfType<OsuPopover>().Any());
+            AddAssert("preset is changed", () => panel.Preset.Value.Name != presetName);
+        }
+
+        [Test]
+        public void TestEditPresetMod()
+        {
+            ModPresetColumn modPresetColumn = null!;
+            var mods = new Mod[] { new OsuModHidden(), new OsuModHardRock() };
+            List<Mod> previousMod = null!;
+
+            AddStep("clear mods", () => SelectedMods.Value = Array.Empty<Mod>());
+            AddStep("create content", () => Child = modPresetColumn = new ModPresetColumn
+            {
+                Anchor = Anchor.Centre,
+                Origin = Anchor.Centre,
+            });
+
+            AddUntilStep("items loaded", () => modPresetColumn.IsLoaded && modPresetColumn.ItemsLoaded);
+
+            AddStep("right click first panel", () =>
+            {
+                var panel = this.ChildrenOfType<ModPresetPanel>().First();
+                previousMod = panel.Preset.Value.Mods.ToList();
+                InputManager.MoveMouseTo(panel);
+                InputManager.Click(MouseButton.Right);
+            });
+            AddUntilStep("wait for context menu", () => this.ChildrenOfType<OsuContextMenu>().Any());
+            AddStep("click edit", () =>
+            {
+                var editItem = this.ChildrenOfType<DrawableOsuMenuItem>().ElementAt(0);
+                InputManager.MoveMouseTo(editItem);
+                InputManager.Click(MouseButton.Left);
+            });
+
+            OsuPopover? popover = null;
+            AddUntilStep("wait for popover", () => (popover = this.ChildrenOfType<OsuPopover>().FirstOrDefault()) != null);
+            AddStep("click use current mods", () =>
+            {
+                InputManager.MoveMouseTo(popover.ChildrenOfType<ShearedButton>().ElementAt(0));
+                InputManager.Click(MouseButton.Left);
+            });
+            AddStep("attempt preset edit", () =>
+            {
+                InputManager.MoveMouseTo(popover.ChildrenOfType<ShearedButton>().ElementAt(1));
+                InputManager.Click(MouseButton.Left);
+            });
+
+            AddUntilStep("preset mod not changed", () =>
+                new HashSet<Mod>(this.ChildrenOfType<ModPresetPanel>().First().Preset.Value.Mods).SetEquals(previousMod));
+
+            AddStep("select mods", () => SelectedMods.Value = mods);
+            AddStep("right click first panel", () =>
+            {
+                var panel = this.ChildrenOfType<ModPresetPanel>().First();
+                InputManager.MoveMouseTo(panel);
+                InputManager.Click(MouseButton.Right);
+            });
+
+            AddUntilStep("wait for context menu", () => this.ChildrenOfType<OsuContextMenu>().Any());
+            AddStep("click edit", () =>
+            {
+                var editItem = this.ChildrenOfType<DrawableOsuMenuItem>().ElementAt(0);
+                InputManager.MoveMouseTo(editItem);
+                InputManager.Click(MouseButton.Left);
+            });
+
+            AddUntilStep("wait for popover", () => (popover = this.ChildrenOfType<OsuPopover>().FirstOrDefault()) != null);
+            AddStep("click use current mods", () =>
+            {
+                InputManager.MoveMouseTo(popover.ChildrenOfType<ShearedButton>().ElementAt(0));
+                InputManager.Click(MouseButton.Left);
+            });
+            AddStep("attempt preset edit", () =>
+            {
+                InputManager.MoveMouseTo(popover.ChildrenOfType<ShearedButton>().ElementAt(1));
+                InputManager.Click(MouseButton.Left);
+            });
+
+            AddUntilStep("preset mod is changed", () =>
+                new HashSet<Mod>(this.ChildrenOfType<ModPresetPanel>().First().Preset.Value.Mods).SetEquals(mods));
+        }
+
         private ICollection<ModPreset> createTestPresets() => new[]
         {
             new ModPreset

osu.Game/Localisation/ModSelectOverlayStrings.cs

@@ -34,6 +34,11 @@ namespace osu.Game.Localisation
         /// </summary>
         public static LocalisableString AddPreset => new TranslatableString(getKey(@"add_preset"), @"Add preset");
 
+        /// <summary>
+        /// "Use current mods"
+        /// </summary>
+        public static LocalisableString UseCurrentMods => new TranslatableString(getKey(@"use_current_mods"), @"Use current mods");
+
         private static string getKey(string key) => $@"{prefix}:{key}";
     }
 }

osu.Game/Overlays/Mods/AddPresetPopover.cs

@@ -9,7 +9,6 @@ using osu.Framework.Extensions;
 using osu.Framework.Graphics;
 using osu.Framework.Graphics.Containers;
 using osu.Game.Database;
-using osu.Game.Extensions;
 using osu.Game.Graphics;
 using osu.Game.Graphics.UserInterface;
 using osu.Game.Graphics.UserInterfaceV2;
@@ -67,7 +66,7 @@ namespace osu.Game.Overlays.Mods
                         Anchor = Anchor.TopCentre,
                         Origin = Anchor.TopCentre,
                         Text = ModSelectOverlayStrings.AddPreset,
-                        Action = tryCreatePreset
+                        Action = createPreset
                     }
                 }
             };
@@ -89,16 +88,15 @@ namespace osu.Game.Overlays.Mods
             base.LoadComplete();
 
             ScheduleAfterChildren(() => GetContainingInputManager().ChangeFocus(nameTextBox));
+
+            nameTextBox.Current.BindValueChanged(s =>
+            {
+                createButton.Enabled.Value = !string.IsNullOrWhiteSpace(s.NewValue);
+            }, true);
         }
 
-        private void tryCreatePreset()
+        private void createPreset()
         {
-            if (string.IsNullOrWhiteSpace(nameTextBox.Current.Value))
-            {
-                Body.Shake();
-                return;
-            }
-
             realm.Write(r => r.Add(new ModPreset
             {
                 Name = nameTextBox.Current.Value,

osu.Game/Overlays/Mods/EditPresetPopover.cs

@@ -0,0 +1,172 @@
+// 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.Linq;
+using osu.Framework.Allocation;
+using osu.Framework.Bindables;
+using osu.Framework.Extensions;
+using osu.Framework.Graphics;
+using osu.Framework.Graphics.Containers;
+using osu.Game.Database;
+using osu.Game.Graphics;
+using osu.Game.Graphics.Containers;
+using osu.Game.Graphics.UserInterface;
+using osu.Game.Graphics.UserInterfaceV2;
+using osu.Game.Localisation;
+using osu.Game.Rulesets.Mods;
+using osuTK;
+
+namespace osu.Game.Overlays.Mods
+{
+    internal partial class EditPresetPopover : OsuPopover
+    {
+        private LabelledTextBox nameTextBox = null!;
+        private LabelledTextBox descriptionTextBox = null!;
+        private ShearedButton useCurrentModsButton = null!;
+        private ShearedButton saveButton = null!;
+        private FillFlowContainer scrollContent = null!;
+
+        private readonly Live<ModPreset> preset;
+
+        private HashSet<Mod> saveableMods;
+
+        [Resolved]
+        private Bindable<IReadOnlyList<Mod>> selectedMods { get; set; } = null!;
+
+        [Resolved]
+        private OsuColour colours { get; set; } = null!;
+
+        [Resolved]
+        private OverlayColourProvider colourProvider { get; set; } = null!;
+
+        public EditPresetPopover(Live<ModPreset> preset)
+        {
+            this.preset = preset;
+            saveableMods = preset.PerformRead(p => p.Mods).ToHashSet();
+        }
+
+        [BackgroundDependencyLoader]
+        private void load()
+        {
+            Child = new FillFlowContainer
+            {
+                Width = 300,
+                AutoSizeAxes = Axes.Y,
+                Spacing = new Vector2(7),
+                Direction = FillDirection.Vertical,
+                Children = new Drawable[]
+                {
+                    nameTextBox = new LabelledTextBox
+                    {
+                        Anchor = Anchor.TopCentre,
+                        Origin = Anchor.TopCentre,
+                        Label = CommonStrings.Name,
+                        TabbableContentContainer = this,
+                        Current = { Value = preset.PerformRead(p => p.Name) },
+                    },
+                    descriptionTextBox = new LabelledTextBox
+                    {
+                        Anchor = Anchor.TopCentre,
+                        Origin = Anchor.TopCentre,
+                        Label = CommonStrings.Description,
+                        TabbableContentContainer = this,
+                        Current = { Value = preset.PerformRead(p => p.Description) },
+                    },
+                    new OsuScrollContainer
+                    {
+                        RelativeSizeAxes = Axes.X,
+                        Height = 100,
+                        Padding = new MarginPadding(7),
+                        Child = scrollContent = new FillFlowContainer
+                        {
+                            RelativeSizeAxes = Axes.X,
+                            AutoSizeAxes = Axes.Y,
+                            Padding = new MarginPadding(7),
+                            Spacing = new Vector2(7),
+                        }
+                    },
+                    new FillFlowContainer
+                    {
+                        Anchor = Anchor.TopCentre,
+                        Origin = Anchor.TopCentre,
+                        Direction = FillDirection.Horizontal,
+                        AutoSizeAxes = Axes.Y,
+                        Spacing = new Vector2(7),
+                        Children = new Drawable[]
+                        {
+                            useCurrentModsButton = new ShearedButton
+                            {
+                                Anchor = Anchor.TopCentre,
+                                Origin = Anchor.TopCentre,
+                                Text = ModSelectOverlayStrings.UseCurrentMods,
+                                DarkerColour = colours.Blue1,
+                                LighterColour = colours.Blue0,
+                                TextColour = colourProvider.Background6,
+                                Action = useCurrentMods,
+                            },
+                            saveButton = new ShearedButton
+                            {
+                                Anchor = Anchor.TopCentre,
+                                Origin = Anchor.TopCentre,
+                                Text = Resources.Localisation.Web.CommonStrings.ButtonsSave,
+                                DarkerColour = colours.Orange1,
+                                LighterColour = colours.Orange0,
+                                TextColour = colourProvider.Background6,
+                                Action = save,
+                            },
+                        }
+                    }
+                }
+            };
+
+            Body.BorderThickness = 3;
+            Body.BorderColour = colours.Orange1;
+
+            selectedMods.BindValueChanged(_ => updateState(), true);
+            nameTextBox.Current.BindValueChanged(s =>
+            {
+                saveButton.Enabled.Value = !string.IsNullOrWhiteSpace(s.NewValue);
+            }, true);
+        }
+
+        private void useCurrentMods()
+        {
+            saveableMods = selectedMods.Value.ToHashSet();
+            updateState();
+        }
+
+        private void updateState()
+        {
+            scrollContent.ChildrenEnumerable = saveableMods.Select(mod => new ModPresetRow(mod));
+            useCurrentModsButton.Enabled.Value = checkSelectedModsDiffersFromSaved();
+        }
+
+        private bool checkSelectedModsDiffersFromSaved()
+        {
+            if (!selectedMods.Value.Any())
+                return false;
+
+            return !saveableMods.SetEquals(selectedMods.Value);
+        }
+
+        protected override void LoadComplete()
+        {
+            base.LoadComplete();
+
+            ScheduleAfterChildren(() => GetContainingInputManager().ChangeFocus(nameTextBox));
+        }
+
+        private void save()
+        {
+            preset.PerformWrite(s =>
+            {
+                s.Name = nameTextBox.Current.Value;
+                s.Description = descriptionTextBox.Current.Value;
+                s.Mods = saveableMods;
+            });
+
+            this.HidePopover();
+        }
+    }
+}

osu.Game/Overlays/Mods/ModPresetPanel.cs

@@ -6,6 +6,7 @@ using System.Collections.Generic;
 using System.Linq;
 using osu.Framework.Allocation;
 using osu.Framework.Bindables;
+using osu.Framework.Extensions;
 using osu.Framework.Graphics.Cursor;
 using osu.Framework.Graphics.UserInterface;
 using osu.Game.Configuration;
@@ -17,7 +18,7 @@ using osu.Game.Rulesets.Mods;
 
 namespace osu.Game.Overlays.Mods
 {
-    public partial class ModPresetPanel : ModSelectPanel, IHasCustomTooltip<ModPreset>, IHasContextMenu
+    public partial class ModPresetPanel : ModSelectPanel, IHasCustomTooltip<ModPreset>, IHasContextMenu, IHasPopover
     {
         public readonly Live<ModPreset> Preset;
 
@@ -91,7 +92,8 @@ namespace osu.Game.Overlays.Mods
 
         public MenuItem[] ContextMenuItems => new MenuItem[]
         {
-            new OsuMenuItem(CommonStrings.ButtonsDelete, MenuItemType.Destructive, () => dialogOverlay?.Push(new DeleteModPresetDialog(Preset)))
+            new OsuMenuItem(CommonStrings.ButtonsEdit, MenuItemType.Highlighted, this.ShowPopover),
+            new OsuMenuItem(CommonStrings.ButtonsDelete, MenuItemType.Destructive, () => dialogOverlay?.Push(new DeleteModPresetDialog(Preset))),
         };
 
         #endregion
@@ -102,5 +104,7 @@ namespace osu.Game.Overlays.Mods
 
             settingChangeTracker?.Dispose();
         }
+
+        public Popover GetPopover() => new EditPresetPopover(Preset);
     }
 }

osu.Game/Overlays/Mods/ModPresetRow.cs

@@ -0,0 +1,64 @@
+// 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 osu.Framework.Graphics;
+using osu.Framework.Graphics.Containers;
+using osu.Game.Graphics;
+using osu.Game.Graphics.Containers;
+using osu.Game.Graphics.Sprites;
+using osu.Game.Rulesets.Mods;
+using osu.Game.Rulesets.UI;
+using osuTK;
+
+namespace osu.Game.Overlays.Mods
+{
+    public partial class ModPresetRow : FillFlowContainer
+    {
+        public ModPresetRow(Mod mod)
+        {
+            RelativeSizeAxes = Axes.X;
+            AutoSizeAxes = Axes.Y;
+            Direction = FillDirection.Vertical;
+            Spacing = new Vector2(4);
+            InternalChildren = new Drawable[]
+            {
+                new FillFlowContainer
+                {
+                    RelativeSizeAxes = Axes.X,
+                    AutoSizeAxes = Axes.Y,
+                    Direction = FillDirection.Horizontal,
+                    Spacing = new Vector2(7),
+                    Children = new Drawable[]
+                    {
+                        new ModSwitchTiny(mod)
+                        {
+                            Active = { Value = true },
+                            Scale = new Vector2(0.6f),
+                            Anchor = Anchor.CentreLeft,
+                            Origin = Anchor.CentreLeft
+                        },
+                        new OsuSpriteText
+                        {
+                            Text = mod.Name,
+                            Font = OsuFont.Default.With(size: 16, weight: FontWeight.SemiBold),
+                            Origin = Anchor.CentreLeft,
+                            Anchor = Anchor.CentreLeft,
+                            Margin = new MarginPadding { Bottom = 2 }
+                        }
+                    }
+                }
+            };
+
+            if (!string.IsNullOrEmpty(mod.SettingDescription))
+            {
+                AddInternal(new OsuTextFlowContainer
+                {
+                    RelativeSizeAxes = Axes.X,
+                    AutoSizeAxes = Axes.Y,
+                    Padding = new MarginPadding { Left = 14 },
+                    Text = mod.SettingDescription
+                });
+            }
+        }
+    }
+}

osu.Game/Overlays/Mods/ModPresetTooltip.cs

@@ -6,11 +6,7 @@ using osu.Framework.Graphics;
 using osu.Framework.Graphics.Containers;
 using osu.Framework.Graphics.Cursor;
 using osu.Framework.Graphics.Shapes;
-using osu.Game.Graphics;
-using osu.Game.Graphics.Containers;
-using osu.Game.Graphics.Sprites;
 using osu.Game.Rulesets.Mods;
-using osu.Game.Rulesets.UI;
 using osuTK;
 
 namespace osu.Game.Overlays.Mods
@@ -61,55 +57,5 @@ namespace osu.Game.Overlays.Mods
         protected override void PopOut() => this.FadeOut(transition_duration, Easing.OutQuint);
 
         public void Move(Vector2 pos) => Position = pos;
-
-        private partial class ModPresetRow : FillFlowContainer
-        {
-            public ModPresetRow(Mod mod)
-            {
-                RelativeSizeAxes = Axes.X;
-                AutoSizeAxes = Axes.Y;
-                Direction = FillDirection.Vertical;
-                Spacing = new Vector2(4);
-                InternalChildren = new Drawable[]
-                {
-                    new FillFlowContainer
-                    {
-                        RelativeSizeAxes = Axes.X,
-                        AutoSizeAxes = Axes.Y,
-                        Direction = FillDirection.Horizontal,
-                        Spacing = new Vector2(7),
-                        Children = new Drawable[]
-                        {
-                            new ModSwitchTiny(mod)
-                            {
-                                Active = { Value = true },
-                                Scale = new Vector2(0.6f),
-                                Anchor = Anchor.CentreLeft,
-                                Origin = Anchor.CentreLeft
-                            },
-                            new OsuSpriteText
-                            {
-                                Text = mod.Name,
-                                Font = OsuFont.Default.With(size: 16, weight: FontWeight.SemiBold),
-                                Origin = Anchor.CentreLeft,
-                                Anchor = Anchor.CentreLeft,
-                                Margin = new MarginPadding { Bottom = 2 }
-                            }
-                        }
-                    }
-                };
-
-                if (!string.IsNullOrEmpty(mod.SettingDescription))
-                {
-                    AddInternal(new OsuTextFlowContainer
-                    {
-                        RelativeSizeAxes = Axes.X,
-                        AutoSizeAxes = Axes.Y,
-                        Padding = new MarginPadding { Left = 14 },
-                        Text = mod.SettingDescription
-                    });
-                }
-            }
-        }
     }
 }