Merge pull request #2201 from Vidalee/osu-hd-setting

Add a setting to increase visibility of the first object in "Hidden" mod

osu.Game.Rulesets.Osu/Mods/OsuModHidden.cs

@@ -7,33 +7,34 @@ using System.Linq;
 using osu.Framework.Graphics;
 using osu.Game.Rulesets.Mods;
 using osu.Game.Rulesets.Objects.Drawables;
+using osu.Game.Rulesets.Osu.Objects.Drawables;
 using osu.Game.Rulesets.Objects.Types;
 using osu.Game.Rulesets.Osu.Objects;
-using osu.Game.Rulesets.Osu.Objects.Drawables;
 
 namespace osu.Game.Rulesets.Osu.Mods
 {
-    public class OsuModHidden : ModHidden, IApplicableToDrawableHitObjects
+    public class OsuModHidden : ModHidden
     {
         public override string Description => @"Play with no approach circles and fading circles/sliders.";
         public override double ScoreMultiplier => 1.06;
-
         private const double fade_in_duration_multiplier = 0.4;
         private const double fade_out_duration_multiplier = 0.3;
 
-        public void ApplyToDrawableHitObjects(IEnumerable<DrawableHitObject> drawables)
+        public override void ApplyToDrawableHitObjects(IEnumerable<DrawableHitObject> drawables)
         {
+            void adjustFadeIn(OsuHitObject h) => h.TimeFadein = h.TimePreempt * fade_in_duration_multiplier;
+
             foreach (var d in drawables.OfType<DrawableOsuHitObject>())
             {
-                d.ApplyCustomUpdateState += ApplyHiddenState;
-
-                d.HitObject.TimeFadein = d.HitObject.TimePreempt * fade_in_duration_multiplier;
+                adjustFadeIn(d.HitObject);
                 foreach (var h in d.HitObject.NestedHitObjects.OfType<OsuHitObject>())
-                    h.TimeFadein = h.TimePreempt * fade_in_duration_multiplier;
+                    adjustFadeIn(h);
             }
+
+            base.ApplyToDrawableHitObjects(drawables);
         }
 
-        protected void ApplyHiddenState(DrawableHitObject drawable, ArmedState state)
+        protected override void ApplyHiddenState(DrawableHitObject drawable, ArmedState state)
         {
             if (!(drawable is DrawableOsuHitObject d))
                 return;

osu.Game/Configuration/OsuConfigManager.cs

@@ -82,6 +82,8 @@ namespace osu.Game.Configuration
 
             Set(OsuSetting.SpeedChangeVisualisation, SpeedChangeVisualisationMethod.Sequential);
 
+            Set(OsuSetting.IncreaseFirstObjectVisibility, true);
+
             // Update
             Set(OsuSetting.ReleaseStream, ReleaseStream.Lazer);
 
@@ -144,6 +146,7 @@ namespace osu.Game.Configuration
         ScreenshotCaptureMenuCursor,
         SongSelectRightMouseScroll,
         BeatmapSkins,
-        BeatmapHitsounds
+        BeatmapHitsounds,
+        IncreaseFirstObjectVisibility
     }
 }

osu.Game/Overlays/Settings/Sections/Gameplay/ModsSettings.cs

@@ -0,0 +1,26 @@
+// Copyright (c) 2007-2018 ppy Pty Ltd <contact@ppy.sh>.
+// Licensed under the MIT Licence - https://raw.githubusercontent.com/ppy/osu/master/LICENCE
+
+using osu.Framework.Allocation;
+using osu.Game.Configuration;
+
+namespace osu.Game.Overlays.Settings.Sections.Gameplay
+{
+    public class ModsSettings : SettingsSubsection
+    {
+        protected override string Header => "Mods";
+
+        [BackgroundDependencyLoader]
+        private void load(OsuConfigManager config)
+        {
+            Children = new[]
+            {
+                new SettingsCheckbox
+                {
+                    LabelText = "Increase visibility of first object with \"Hidden\" mod",
+                    Bindable = config.GetBindable<bool>(OsuSetting.IncreaseFirstObjectVisibility)
+                },
+            };
+        }
+    }
+}

osu.Game/Overlays/Settings/Sections/GameplaySection.cs

@@ -21,7 +21,8 @@ namespace osu.Game.Overlays.Settings.Sections
             {
                 new GeneralSettings(),
                 new SongSelectSettings(),
-                new ScrollingSettings()
+                new ScrollingSettings(),
+                new ModsSettings(),
             };
         }
 

osu.Game/Rulesets/Mods/IReadFromConfig.cs

@@ -0,0 +1,15 @@
+// Copyright (c) 2007-2018 ppy Pty Ltd <contact@ppy.sh>.
+// Licensed under the MIT Licence - https://raw.githubusercontent.com/ppy/osu/master/LICENCE
+
+using osu.Game.Configuration;
+
+namespace osu.Game.Rulesets.Mods
+{
+    /// <summary>
+    /// An interface for mods that require reading access to the osu! configuration.
+    /// </summary>
+    public interface IReadFromConfig
+    {
+        void ReadFromConfig(OsuConfigManager config);
+    }
+}

osu.Game/Rulesets/Mods/ModHidden.cs

@@ -1,16 +1,37 @@
 // Copyright (c) 2007-2018 ppy Pty Ltd <contact@ppy.sh>.
 // Licensed under the MIT Licence - https://raw.githubusercontent.com/ppy/osu/master/LICENCE
 
+using osu.Framework.Configuration;
+using osu.Game.Configuration;
 using osu.Game.Graphics;
+using osu.Game.Rulesets.Objects.Drawables;
+using System.Collections.Generic;
+using System.Linq;
 
 namespace osu.Game.Rulesets.Mods
 {
-    public abstract class ModHidden : Mod
+    public abstract class ModHidden : Mod, IReadFromConfig, IApplicableToDrawableHitObjects
     {
         public override string Name => "Hidden";
         public override string ShortenedName => "HD";
         public override FontAwesome Icon => FontAwesome.fa_osu_mod_hidden;
         public override ModType Type => ModType.DifficultyIncrease;
         public override bool Ranked => true;
+
+        protected Bindable<bool> IncreaseFirstObjectVisibility = new Bindable<bool>();
+
+        public void ReadFromConfig(OsuConfigManager config)
+        {
+            IncreaseFirstObjectVisibility = config.GetBindable<bool>(OsuSetting.IncreaseFirstObjectVisibility);
+        }
+
+        public virtual void ApplyToDrawableHitObjects(IEnumerable<DrawableHitObject> drawables)
+        {
+            // todo: fix ordering of objects so we don't have to do this (#2740).
+            foreach (var d in drawables.Reverse().Skip(IncreaseFirstObjectVisibility ? 1 : 0))
+                d.ApplyCustomUpdateState += ApplyHiddenState;
+        }
+
+        protected virtual void ApplyHiddenState(DrawableHitObject hitObject, ArmedState state) { }
     }
 }

osu.Game/Rulesets/UI/RulesetContainer.cs

@@ -57,6 +57,7 @@ namespace osu.Game.Rulesets.UI
         public abstract IEnumerable<HitObject> Objects { get; }
 
         private readonly Lazy<Playfield> playfield;
+
         /// <summary>
         /// The playfield.
         /// </summary>
@@ -130,7 +131,6 @@ namespace osu.Game.Rulesets.UI
             HasReplayLoaded.Value = ReplayInputManager.ReplayInputHandler != null;
         }
 
-
         /// <summary>
         /// Creates the cursor. May be null if the <see cref="RulesetContainer"/> doesn't provide a custom cursor.
         /// </summary>
@@ -194,6 +194,7 @@ namespace osu.Game.Rulesets.UI
 
         protected override Container<Drawable> Content => content;
         private Container content;
+        private IEnumerable<Mod> mods;
 
         /// <summary>
         /// Whether to assume the beatmap passed into this <see cref="RulesetContainer{TObject}"/> is for the current ruleset.
@@ -216,13 +217,10 @@ namespace osu.Game.Rulesets.UI
 
             KeyBindingInputManager = CreateInputManager();
             KeyBindingInputManager.RelativeSizeAxes = Axes.Both;
-
-            // Add mods, should always be the last thing applied to give full control to mods
-            applyMods(Mods);
         }
 
         [BackgroundDependencyLoader]
-        private void load()
+        private void load(OsuConfigManager config)
         {
             KeyBindingInputManager.Add(content = new Container
             {
@@ -235,6 +233,9 @@ namespace osu.Game.Rulesets.UI
             if (Cursor != null)
                 KeyBindingInputManager.Add(Cursor);
 
+            // Apply mods
+            applyMods(Mods, config);
+
             loadObjects();
         }
 
@@ -242,13 +243,16 @@ namespace osu.Game.Rulesets.UI
         /// Applies the active mods to this RulesetContainer.
         /// </summary>
         /// <param name="mods"></param>
-        private void applyMods(IEnumerable<Mod> mods)
+        private void applyMods(IEnumerable<Mod> mods, OsuConfigManager config)
         {
             if (mods == null)
                 return;
 
             foreach (var mod in mods.OfType<IApplicableToRulesetContainer<TObject>>())
                 mod.ApplyToRulesetContainer(this);
+
+            foreach (var mod in mods.OfType<IReadFromConfig>())
+                mod.ReadFromConfig(config);
         }
 
         public override void SetReplay(Replay replay)