Merge branch 'master' into large-texture-store

osu-framework

@@ -1 +1 @@
-Subproject commit 66421b894444cb9c4b792f9b93a786dcff5589dd
+Subproject commit 6134dafccb3368dac96d837537325c04b89fb8ee

osu.Game.Rulesets.Mania/Mods/ManiaMod.cs

@@ -105,6 +105,8 @@ namespace osu.Game.Rulesets.Mania.Mods
 
     public abstract class ManiaKeyMod : Mod
     {
+        // TODO: implement using the IApplicable interface. Haven't done so yet because KeyCount isn't even hooked up at the moment.
+
         public override string ShortenedName => Name;
         public abstract int KeyCount { get; }
         public override double ScoreMultiplier => 1; // TODO: Implement the mania key mod score multiplier

osu.Game.Tests/Visual/TestCaseMods.cs

@@ -15,6 +15,8 @@ using System.Collections.Generic;
 using osu.Game.Rulesets.Osu;
 using osu.Game.Graphics.UserInterface;
 using osu.Game.Graphics.Sprites;
+using osu.Game.Rulesets.Mania;
+using osu.Game.Rulesets.Mania.Mods;
 using OpenTK.Graphics;
 
 namespace osu.Game.Tests.Visual
@@ -68,6 +70,9 @@ namespace osu.Game.Tests.Visual
                     case OsuRuleset or:
                         testOsuMods(or);
                         break;
+                    case ManiaRuleset mr:
+                        testManiaMods(mr);
+                        break;
                 }
             }
         }
@@ -80,16 +85,27 @@ namespace osu.Game.Tests.Visual
 
             var noFailMod = easierMods.FirstOrDefault(m => m is OsuModNoFail);
             var hiddenMod = harderMods.FirstOrDefault(m => m is OsuModHidden);
+
             var doubleTimeMod = harderMods.OfType<MultiMod>().FirstOrDefault(m => m.Mods.Any(a => a is OsuModDoubleTime));
+
             var autoPilotMod = assistMods.FirstOrDefault(m => m is OsuModAutopilot);
 
+            var easy = easierMods.FirstOrDefault(m => m is OsuModEasy);
+            var hardRock = harderMods.FirstOrDefault(m => m is OsuModHardRock);
+
             testSingleMod(noFailMod);
             testMultiMod(doubleTimeMod);
-            testIncompatibleMods(noFailMod, autoPilotMod);
+            testIncompatibleMods(easy, hardRock);
             testDeselectAll(easierMods.Where(m => !(m is MultiMod)));
             testMultiplierTextColour(noFailMod, modSelect.LowMultiplierColour);
             testMultiplierTextColour(hiddenMod, modSelect.HighMultiplierColour);
-            testMultiplierTextUnranked(autoPilotMod);
+
+            testUnimplmentedMod(autoPilotMod);
+        }
+
+        private void testManiaMods(ManiaRuleset ruleset)
+        {
+            testMultiplierTextUnranked(ruleset.GetModsFor(ModType.Special).First(m => m is ManiaModRandom));
         }
 
         private void testSingleMod(Mod mod)
@@ -124,6 +140,12 @@ namespace osu.Game.Tests.Visual
                 checkNotSelected(mod);
         }
 
+        private void testUnimplmentedMod(Mod mod)
+        {
+            selectNext(mod);
+            checkNotSelected(mod);
+        }
+
         private void testIncompatibleMods(Mod modA, Mod modB)
         {
             selectNext(modA);
@@ -169,9 +191,9 @@ namespace osu.Game.Tests.Visual
             AddAssert("check for ranked", () => !modSelect.MultiplierLabel.Text.EndsWith(unranked_suffix));
         }
 
-        private void selectNext(Mod mod) => AddStep($"left click {mod.Name}", () => modSelect.GetModButton(mod)?.SelectNext());
+        private void selectNext(Mod mod) => AddStep($"left click {mod.Name}", () => modSelect.GetModButton(mod)?.SelectNext(1));
 
-        private void selectPrevious(Mod mod) => AddStep($"right click {mod.Name}", () => modSelect.GetModButton(mod)?.SelectPrevious());
+        private void selectPrevious(Mod mod) => AddStep($"right click {mod.Name}", () => modSelect.GetModButton(mod)?.SelectNext(-1));
 
         private void checkSelected(Mod mod)
         {

osu.Game/Overlays/Mods/ModButton.cs

@@ -32,7 +32,10 @@ namespace osu.Game.Overlays.Mods
         private readonly Container<ModIcon> iconsContainer;
         private SampleChannel sampleOn, sampleOff;
 
-        public Action<Mod> Action; // Passed the selected mod or null if none
+        /// <summary>
+        /// Fired when the selection changes.
+        /// </summary>
+        public Action<Mod> SelectionChanged;
 
         public string TooltipText => (SelectedMod?.Description ?? Mods.FirstOrDefault()?.Description) ?? string.Empty;
 
@@ -42,28 +45,29 @@ namespace osu.Game.Overlays.Mods
         // A selected index of -1 means not selected.
         private int selectedIndex = -1;
 
-        protected int SelectedIndex
+        /// <summary>
+        /// Change the selected mod index of this button.
+        /// </summary>
+        /// <param name="newIndex">The new index.</param>
+        /// <returns>Whether the selection changed.</returns>
+        private bool changeSelectedIndex(int newIndex)
         {
-            get
+            if (newIndex == selectedIndex) return false;
-            {
-                return selectedIndex;
-            }
-            set
-            {
-                if (value == selectedIndex) return;
 
-                int direction = value < selectedIndex ? -1 : 1;
+            int direction = newIndex < selectedIndex ? -1 : 1;
             bool beforeSelected = Selected;
 
             Mod modBefore = SelectedMod ?? Mods[0];
 
-                if (value >= Mods.Length)
+            if (newIndex >= Mods.Length)
-                    selectedIndex = -1;
+                newIndex = -1;
-                else if (value < -1)
+            else if (newIndex < -1)
-                    selectedIndex = Mods.Length - 1;
+                newIndex = Mods.Length - 1;
-                else
-                    selectedIndex = value;
 
+            if (newIndex >= 0 && !Mods[newIndex].HasImplementation)
+                return false;
+
+            selectedIndex = newIndex;
             Mod modAfter = SelectedMod ?? Mods[0];
 
             if (beforeSelected != Selected)
@@ -95,18 +99,19 @@ namespace osu.Game.Overlays.Mods
             }
 
             foregroundIcon.Highlighted = Selected;
-            }
+
+            (selectedIndex == -1 ? sampleOff : sampleOn).Play();
+            SelectionChanged?.Invoke(SelectedMod);
+            return true;
         }
 
-        public bool Selected => SelectedIndex != -1;
+        public bool Selected => selectedIndex != -1;
 
         private Color4 selectedColour;
+
         public Color4 SelectedColour
         {
-            get
+            get { return selectedColour; }
-            {
-                return selectedColour;
-            }
             set
             {
                 if (value == selectedColour) return;
@@ -116,12 +121,10 @@ namespace osu.Game.Overlays.Mods
         }
 
         private Mod mod;
+
         public Mod Mod
         {
-            get
+            get { return mod; }
-            {
-                return mod;
-            }
             set
             {
                 mod = value;
@@ -147,9 +150,7 @@ namespace osu.Game.Overlays.Mods
 
         public Mod[] Mods { get; private set; }
 
-        // the mods from Mod, only multiple if Mod is a MultiMod
+        public virtual Mod SelectedMod => Mods.ElementAtOrDefault(selectedIndex);
-
-        public virtual Mod SelectedMod => Mods.ElementAtOrDefault(SelectedIndex);
 
         [BackgroundDependencyLoader]
         private void load(AudioManager audio)
@@ -163,31 +164,42 @@ namespace osu.Game.Overlays.Mods
             switch (args.Button)
             {
                 case MouseButton.Left:
-                    SelectNext();
+                    SelectNext(1);
                     break;
                 case MouseButton.Right:
-                    SelectPrevious();
+                    SelectNext(-1);
                     break;
             }
+
             return true;
         }
 
-        public void SelectNext()
+        /// <summary>
+        /// Select the next available mod in a specified direction.
+        /// </summary>
+        /// <param name="direction">1 for forwards, -1 for backwards.</param>
+        public void SelectNext(int direction)
         {
-            (++SelectedIndex == Mods.Length ? sampleOff : sampleOn).Play();
+            int start = selectedIndex + direction;
-            Action?.Invoke(SelectedMod);
+            // wrap around if we are at an extremity.
+            if (start >= Mods.Length)
+                start = -1;
+            else if (start < -1)
+                start = Mods.Length - 1;
+
+            for (int i = start; i < Mods.Length && i >= 0; i += direction)
+            {
+                if (Mods[i].HasImplementation)
+                {
+                    changeSelectedIndex(i);
+                    return;
+                }
             }
 
-        public void SelectPrevious()
+            Deselect();
-        {
-            (--SelectedIndex == -1 ? sampleOff : sampleOn).Play();
-            Action?.Invoke(SelectedMod);
         }
 
-        public void Deselect()
+        public void Deselect() => changeSelectedIndex(-1);
-        {
-            SelectedIndex = -1;
-        }
 
         private void displayMod(Mod mod)
         {
@@ -195,6 +207,7 @@ namespace osu.Game.Overlays.Mods
                 backgroundIcon.Icon = foregroundIcon.Icon;
             foregroundIcon.Icon = mod.Icon;
             text.Text = mod.Name;
+            Colour = mod.HasImplementation ? Color4.White : Color4.Gray;
         }
 
         private void createIcons()
@@ -264,7 +277,8 @@ namespace osu.Game.Overlays.Mods
         {
             public override string TooltipText => null;
 
-            public PassThroughTooltipModIcon(Mod mod) : base(mod)
+            public PassThroughTooltipModIcon(Mod mod)
+                : base(mod)
             {
             }
         }

osu.Game/Overlays/Mods/ModSection.cs

@@ -51,7 +51,7 @@ namespace osu.Game.Overlays.Mods
                         return new ModButton(m)
                         {
                             SelectedColour = selectedColour,
-                            Action = Action,
+                            SelectionChanged = Action,
                         };
                 }).ToArray();
 
@@ -83,26 +83,33 @@ namespace osu.Game.Overlays.Mods
         {
             var index = Array.IndexOf(ToggleKeys, args.Key);
             if (index > -1 && index < buttons.Length)
-                buttons[index].SelectNext();
+                buttons[index].SelectNext(state.Keyboard.ShiftPressed ? -1 : 1);
 
             return base.OnKeyDown(state, args);
         }
 
-        public void DeselectAll()
+        public void DeselectAll() => DeselectTypes(buttons.Select(b => b.SelectedMod?.GetType()).Where(t => t != null));
-        {
-            foreach (ModButton button in buttons)
-                button.Deselect();
-        }
 
-        public void DeselectTypes(Type[] modTypes)
+        /// <summary>
+        /// Deselect one or more mods in this section.
+        /// </summary>
+        /// <param name="modTypes">The types of <see cref="Mod"/>s which should be deselected.</param>
+        /// <param name="immediate">Set to true to bypass animations and update selections immediately.</param>
+        public void DeselectTypes(IEnumerable<Type> modTypes, bool immediate = false)
         {
+            int delay = 0;
             foreach (var button in buttons)
             {
                 Mod selected = button.SelectedMod;
                 if (selected == null) continue;
                 foreach (Type type in modTypes)
                     if (type.IsInstanceOfType(selected))
+                    {
+                        if (immediate)
                             button.Deselect();
+                        else
+                            Scheduler.AddDelayed(() => button.Deselect(), delay += 50);
+                    }
             }
         }
 

osu.Game/Overlays/Mods/ModSelectOverlay.cs

@@ -100,17 +100,22 @@ namespace osu.Game.Overlays.Mods
             refreshSelectedMods();
         }
 
-        public void DeselectTypes(Type[] modTypes)
+        /// <summary>
+        /// Deselect one or more mods.
+        /// </summary>
+        /// <param name="modTypes">The types of <see cref="Mod"/>s which should be deselected.</param>
+        /// <param name="immediate">Set to true to bypass animations and update selections immediately.</param>
+        public void DeselectTypes(Type[] modTypes, bool immediate = false)
         {
             if (modTypes.Length == 0) return;
             foreach (ModSection section in ModSectionsContainer.Children)
-                section.DeselectTypes(modTypes);
+                section.DeselectTypes(modTypes, immediate);
         }
 
         private void modButtonPressed(Mod selectedMod)
         {
             if (selectedMod != null)
-                DeselectTypes(selectedMod.IncompatibleMods);
+                DeselectTypes(selectedMod.IncompatibleMods, true);
             refreshSelectedMods();
         }
 
@@ -127,10 +132,6 @@ namespace osu.Game.Overlays.Mods
                 ranked &= mod.Ranked;
             }
 
-            // 1.00x
-            // 1.05x
-            // 1.20x
-
             MultiplierLabel.Text = $"{multiplier:N2}x";
             if (!ranked)
                 MultiplierLabel.Text += " (Unranked)";

osu.Game/Rulesets/Mods/IApplicableFailOverride.cs

@@ -0,0 +1,16 @@
+// Copyright (c) 2007-2017 ppy Pty Ltd <contact@ppy.sh>.
+// Licensed under the MIT Licence - https://raw.githubusercontent.com/ppy/osu/master/LICENCE
+
+namespace osu.Game.Rulesets.Mods
+{
+    /// <summary>
+    /// Represents a mod which can override (and block) a fail.
+    /// </summary>
+    public interface IApplicableFailOverride : IApplicableMod
+    {
+        /// <summary>
+        /// Whether we should allow failing at the current point in time.
+        /// </summary>
+        bool AllowFail { get; }
+    }
+}

osu.Game/Rulesets/Mods/IApplicableMod.cs

@@ -0,0 +1,13 @@
+// Copyright (c) 2007-2017 ppy Pty Ltd <contact@ppy.sh>.
+// Licensed under the MIT Licence - https://raw.githubusercontent.com/ppy/osu/master/LICENCE
+
+namespace osu.Game.Rulesets.Mods
+{
+    /// <summary>
+    /// The base interface for a mod which can be applied in some way.
+    /// If this is not implemented by a mod, it will not be available for use in-game.
+    /// </summary>
+    public interface IApplicableMod
+    {
+    }
+}

osu.Game/Rulesets/Mods/IApplicableToClock.cs

@@ -8,7 +8,7 @@ namespace osu.Game.Rulesets.Mods
     /// <summary>
     /// An interface for mods that make adjustments to the track.
     /// </summary>
-    public interface IApplicableToClock
+    public interface IApplicableToClock : IApplicableMod
     {
         void ApplyToClock(IAdjustableClock clock);
     }

osu.Game/Rulesets/Mods/IApplicableToDifficulty.cs

@@ -8,7 +8,7 @@ namespace osu.Game.Rulesets.Mods
     /// <summary>
     /// An interface for mods that make general adjustments to difficulty.
     /// </summary>
-    public interface IApplicableToDifficulty
+    public interface IApplicableToDifficulty : IApplicableMod
     {
         void ApplyToDifficulty(BeatmapDifficulty difficulty);
     }

osu.Game/Rulesets/Mods/IApplicableToDrawableHitObject.cs

@@ -9,7 +9,7 @@ namespace osu.Game.Rulesets.Mods
     /// <summary>
     /// An interface for <see cref="Mod"/>s that can be applied to <see cref="DrawableHitObject"/>s.
     /// </summary>
-    public interface IApplicableToDrawableHitObjects
+    public interface IApplicableToDrawableHitObjects : IApplicableMod
     {
         /// <summary>
         /// Applies this <see cref="IApplicableToDrawableHitObjects"/> to a list of <see cref="DrawableHitObject"/>s.

osu.Game/Rulesets/Mods/IApplicableToHitObject.cs

@@ -8,7 +8,7 @@ namespace osu.Game.Rulesets.Mods
     /// <summary>
     /// An interface for <see cref="Mod"/>s that can be applied to <see cref="HitObject"/>s.
     /// </summary>
-    public interface IApplicableToHitObject<in TObject>
+    public interface IApplicableToHitObject<in TObject> : IApplicableMod
         where TObject : HitObject
     {
         /// <summary>

osu.Game/Rulesets/Mods/IApplicableToRulesetContainer.cs

@@ -9,7 +9,7 @@ namespace osu.Game.Rulesets.Mods
     /// <summary>
     /// An interface for <see cref="Mod"/>s that can be applied to <see cref="RulesetContainer"/>s.
     /// </summary>
-    public interface IApplicableToRulesetContainer<TObject>
+    public interface IApplicableToRulesetContainer<TObject> : IApplicableMod
         where TObject : HitObject
     {
         /// <summary>

osu.Game/Rulesets/Mods/IApplicableToScoreProcessor.cs

@@ -8,7 +8,7 @@ namespace osu.Game.Rulesets.Mods
     /// <summary>
     /// An interface for mods that make general adjustments to score processor.
     /// </summary>
-    public interface IApplicableToScoreProcessor
+    public interface IApplicableToScoreProcessor : IApplicableMod
     {
         void ApplyToScoreProcessor(ScoreProcessor scoreProcessor);
     }

osu.Game/Rulesets/Mods/Mod.cs

@@ -41,6 +41,11 @@ namespace osu.Game.Rulesets.Mods
         /// </summary>
         public abstract double ScoreMultiplier { get; }
 
+        /// <summary>
+        /// Returns true if this mod is implemented (and playable).
+        /// </summary>
+        public virtual bool HasImplementation => this is IApplicableMod;
+
         /// <summary>
         /// Returns if this mod is ranked.
         /// </summary>
@@ -50,10 +55,5 @@ namespace osu.Game.Rulesets.Mods
         /// The mods this mod cannot be enabled with.
         /// </summary>
         public virtual Type[] IncompatibleMods => new Type[] { };
-
-        /// <summary>
-        /// Whether we should allow failing at the current point in time.
-        /// </summary>
-        public virtual bool AllowFail => true;
     }
 }

osu.Game/Rulesets/Mods/ModAutoplay.cs

@@ -21,7 +21,7 @@ namespace osu.Game.Rulesets.Mods
         }
     }
 
-    public class ModAutoplay : Mod
+    public class ModAutoplay : Mod, IApplicableFailOverride
     {
         public override string Name => "Autoplay";
         public override string ShortenedName => "AT";
@@ -29,6 +29,6 @@ namespace osu.Game.Rulesets.Mods
         public override string Description => "Watch a perfect automated play through the song";
         public override double ScoreMultiplier => 0;
         public override Type[] IncompatibleMods => new[] { typeof(ModRelax), typeof(ModSuddenDeath), typeof(ModNoFail) };
-        public override bool AllowFail => false;
+        public bool AllowFail => false;
     }
 }

osu.Game/Rulesets/Mods/ModNoFail.cs

@@ -6,7 +6,7 @@ using osu.Game.Graphics;
 
 namespace osu.Game.Rulesets.Mods
 {
-    public abstract class ModNoFail : Mod
+    public abstract class ModNoFail : Mod, IApplicableFailOverride
     {
         public override string Name => "NoFail";
         public override string ShortenedName => "NF";
@@ -20,6 +20,6 @@ namespace osu.Game.Rulesets.Mods
         /// <summary>
         /// We never fail, 'yo.
         /// </summary>
-        public override bool AllowFail => false;
+        public bool AllowFail => false;
     }
 }

osu.Game/Screens/Play/Player.cs

@@ -298,7 +298,7 @@ namespace osu.Game.Screens.Play
 
         private bool onFail()
         {
-            if (Beatmap.Value.Mods.Value.Any(m => !m.AllowFail))
+            if (Beatmap.Value.Mods.Value.OfType<IApplicableFailOverride>().Any(m => !m.AllowFail))
                 return false;
 
             decoupledClock.Stop();

osu.Game/osu.Game.csproj

@@ -311,6 +311,8 @@
     <Compile Include="Overlays\Profile\Sections\Ranks\DrawableTotalScore.cs" />
     <Compile Include="Overlays\Profile\Sections\Ranks\ScoreModsContainer.cs" />
     <Compile Include="Overlays\Settings\Sections\Maintenance\DeleteAllBeatmapsDialog.cs" />
+    <Compile Include="Rulesets\Mods\IApplicableFailOverride.cs" />
+    <Compile Include="Rulesets\Mods\IApplicableMod.cs" />
     <Compile Include="Rulesets\Mods\IApplicableToDrawableHitObject.cs" />
     <Compile Include="Screens\Select\ImportFromStablePopup.cs" />
     <Compile Include="Overlays\Settings\SettingsButton.cs" />