From 1960a0d44dab6aa0e3ad9bc3fdfa6c5eb3e1c11d Mon Sep 17 00:00:00 2001
From: OliBomby <olivierschipper@gmail.com>
Date: Tue, 1 Oct 2024 13:07:25 +0200
Subject: [PATCH] Add tooltip to explain why addition banks dont work when no
 additions exist

---
 .../Components/TernaryButtons/DrawableTernaryButton.cs    | 6 +++++-
 .../Edit/Components/TernaryButtons/TernaryButton.cs       | 2 ++
 .../Edit/Compose/Components/ComposeBlueprintContainer.cs  | 8 ++++++++
 .../Edit/Compose/Components/EditorSelectionHandler.cs     | 7 +++++++
 4 files changed, 22 insertions(+), 1 deletion(-)

diff --git a/osu.Game/Screens/Edit/Components/TernaryButtons/DrawableTernaryButton.cs b/osu.Game/Screens/Edit/Components/TernaryButtons/DrawableTernaryButton.cs
index 9e528aa21b..7a9bdfc41f 100644
--- a/osu.Game/Screens/Edit/Components/TernaryButtons/DrawableTernaryButton.cs
+++ b/osu.Game/Screens/Edit/Components/TernaryButtons/DrawableTernaryButton.cs
@@ -4,8 +4,10 @@
 using osu.Framework.Allocation;
 using osu.Framework.Extensions.Color4Extensions;
 using osu.Framework.Graphics;
+using osu.Framework.Graphics.Cursor;
 using osu.Framework.Graphics.Shapes;
 using osu.Framework.Graphics.Sprites;
+using osu.Framework.Localisation;
 using osu.Game.Graphics.Sprites;
 using osu.Game.Graphics.UserInterface;
 using osu.Game.Overlays;
@@ -14,7 +16,7 @@ using osuTK.Graphics;
 
 namespace osu.Game.Screens.Edit.Components.TernaryButtons
 {
-    public partial class DrawableTernaryButton : OsuButton
+    public partial class DrawableTernaryButton : OsuButton, IHasTooltip
     {
         private Color4 defaultBackgroundColour;
         private Color4 defaultIconColour;
@@ -98,5 +100,7 @@ namespace osu.Game.Screens.Edit.Components.TernaryButtons
             Anchor = Anchor.CentreLeft,
             X = 40f
         };
+
+        public LocalisableString TooltipText => Button.Tooltip;
     }
 }
diff --git a/osu.Game/Screens/Edit/Components/TernaryButtons/TernaryButton.cs b/osu.Game/Screens/Edit/Components/TernaryButtons/TernaryButton.cs
index 0ff2aa83b5..b025e4fbf5 100644
--- a/osu.Game/Screens/Edit/Components/TernaryButtons/TernaryButton.cs
+++ b/osu.Game/Screens/Edit/Components/TernaryButtons/TernaryButton.cs
@@ -19,6 +19,8 @@ namespace osu.Game.Screens.Edit.Components.TernaryButtons
         /// </summary>
         public readonly Func<Drawable>? CreateIcon;
 
+        public string Tooltip { get; set; } = string.Empty;
+
         public TernaryButton(Bindable<TernaryState> bindable, string description, Func<Drawable>? createIcon = null)
         {
             Bindable = bindable;
diff --git a/osu.Game/Screens/Edit/Compose/Components/ComposeBlueprintContainer.cs b/osu.Game/Screens/Edit/Compose/Components/ComposeBlueprintContainer.cs
index 76e35a35c6..bfa6da8c7c 100644
--- a/osu.Game/Screens/Edit/Compose/Components/ComposeBlueprintContainer.cs
+++ b/osu.Game/Screens/Edit/Compose/Components/ComposeBlueprintContainer.cs
@@ -68,6 +68,8 @@ namespace osu.Game.Screens.Edit.Compose.Components
             SampleBankTernaryStates = createSampleBankTernaryButtons(SelectionHandler.SelectionBankStates).ToArray();
             SampleAdditionBankTernaryStates = createSampleBankTernaryButtons(SelectionHandler.SelectionAdditionBankStates).ToArray();
 
+            SelectionHandler.SelectionAdditionBanksEnabled.BindValueChanged(_ => updateTernaryButtonTooltips());
+
             AddInternal(new DrawableRulesetDependenciesProvidingContainer(Composer.Ruleset)
             {
                 Child = placementBlueprintContainer
@@ -288,6 +290,12 @@ namespace osu.Game.Screens.Edit.Compose.Components
             return null;
         }
 
+        private void updateTernaryButtonTooltips()
+        {
+            foreach (var ternaryButton in SampleAdditionBankTernaryStates)
+                ternaryButton.Tooltip = !SelectionHandler.SelectionAdditionBanksEnabled.Value ? "Add an addition sample first to be able to set a bank" : string.Empty;
+        }
+
         #region Placement
 
         /// <summary>
diff --git a/osu.Game/Screens/Edit/Compose/Components/EditorSelectionHandler.cs b/osu.Game/Screens/Edit/Compose/Components/EditorSelectionHandler.cs
index 8de3f3052f..a68d3afef8 100644
--- a/osu.Game/Screens/Edit/Compose/Components/EditorSelectionHandler.cs
+++ b/osu.Game/Screens/Edit/Compose/Components/EditorSelectionHandler.cs
@@ -63,6 +63,11 @@ namespace osu.Game.Screens.Edit.Compose.Components
         /// </summary>
         public readonly Dictionary<string, Bindable<TernaryState>> SelectionAdditionBankStates = new Dictionary<string, Bindable<TernaryState>>();
 
+        /// <summary>
+        /// Whether the selection contains any addition samples and the <see cref="SelectionAdditionBankStates"/> can be used.
+        /// </summary>
+        public readonly Bindable<bool> SelectionAdditionBanksEnabled = new Bindable<bool>();
+
         /// <summary>
         /// Set up ternary state bindables and bind them to selection/hitobject changes (in both directions)
         /// </summary>
@@ -266,6 +271,8 @@ namespace osu.Game.Screens.Edit.Compose.Components
                 bindable.Value = GetStateFromSelection(samplesInSelection.SelectMany(s => s).Where(o => o.Name == HitSampleInfo.HIT_NORMAL), h => h.Bank == bankName);
             }
 
+            SelectionAdditionBanksEnabled.Value = samplesInSelection.SelectMany(s => s).Any(o => o.Name != HitSampleInfo.HIT_NORMAL);
+
             foreach ((string bankName, var bindable) in SelectionAdditionBankStates)
             {
                 bindable.Value = GetStateFromSelection(samplesInSelection.SelectMany(s => s).Where(o => o.Name != HitSampleInfo.HIT_NORMAL), h => (bankName != HIT_BANK_AUTO && h.Bank == bankName && !h.EditorAutoBank) || (bankName == HIT_BANK_AUTO && h.EditorAutoBank));