From 2a043aa6de7ae64990a6069e7cb0402d4e8f06fd Mon Sep 17 00:00:00 2001
From: Dean Herbert <pe@ppy.sh>
Date: Fri, 22 Apr 2022 18:04:43 +0900
Subject: [PATCH] Add a method of finding and applying settings with classic
 default value

---
 osu.Game/Overlays/Settings/ISettingsItem.cs |  6 ++++
 osu.Game/Overlays/Settings/SettingsItem.cs  | 36 ++++++++++++++++++++-
 2 files changed, 41 insertions(+), 1 deletion(-)

diff --git a/osu.Game/Overlays/Settings/ISettingsItem.cs b/osu.Game/Overlays/Settings/ISettingsItem.cs
index e7afa48502..e6b1e68741 100644
--- a/osu.Game/Overlays/Settings/ISettingsItem.cs
+++ b/osu.Game/Overlays/Settings/ISettingsItem.cs
@@ -9,5 +9,11 @@ namespace osu.Game.Overlays.Settings
     public interface ISettingsItem : IDrawable, IDisposable
     {
         event Action SettingChanged;
+
+        /// <summary>
+        /// Apply the default values of a setting item, if the setting item specifies a "classic" default via <see cref="SettingsItem{T}.ApplyClassicDefault"/>.
+        /// </summary>
+        /// <param name="useClassicDefault">Whether to apply the classic value. If <c>false</c>, the standard default is applied.</param>
+        void ApplyClassicDefault(bool useClassicDefault);
     }
 }
diff --git a/osu.Game/Overlays/Settings/SettingsItem.cs b/osu.Game/Overlays/Settings/SettingsItem.cs
index 1c5668479f..845a7f5cdf 100644
--- a/osu.Game/Overlays/Settings/SettingsItem.cs
+++ b/osu.Game/Overlays/Settings/SettingsItem.cs
@@ -30,6 +30,8 @@ namespace osu.Game.Overlays.Settings
         /// </summary>
         public object SettingSourceObject { get; internal set; }
 
+        public const string CLASSIC_DEFAULT_SEARCH_TERM = @"has-classic-default";
+
         private IHasCurrentValue<T> controlWithCurrent => Control as IHasCurrentValue<T>;
 
         protected override Container<Drawable> Content => FlowContent;
@@ -96,7 +98,23 @@ namespace osu.Game.Overlays.Settings
             set => controlWithCurrent.Current = value;
         }
 
-        public virtual IEnumerable<string> FilterTerms => Keywords == null ? new[] { LabelText.ToString() } : new List<string>(Keywords) { LabelText.ToString() }.ToArray();
+        public virtual IEnumerable<string> FilterTerms
+        {
+            get
+            {
+                var keywords = new List<string>(Keywords ?? Array.Empty<string>())
+                {
+                    LabelText.ToString()
+                };
+
+                if (GetClassicDefault != null)
+                {
+                    keywords.Add(CLASSIC_DEFAULT_SEARCH_TERM);
+                }
+
+                return keywords;
+            }
+        }
 
         public IEnumerable<string> Keywords { get; set; }
 
@@ -108,6 +126,22 @@ namespace osu.Game.Overlays.Settings
 
         public event Action SettingChanged;
 
+        /// <summary>
+        /// An action which when invoked will apply a classic default value to this setting.
+        /// </summary>
+        public Func<T> GetClassicDefault { get; set; }
+
+        public void ApplyClassicDefault(bool useClassicDefault)
+        {
+            if (GetClassicDefault != null)
+            {
+                if (useClassicDefault)
+                    Current.Value = GetClassicDefault();
+                else
+                    Current.SetDefault();
+            }
+        }
+
         protected SettingsItem()
         {
             RelativeSizeAxes = Axes.X;