Merge pull request #6990 from GSculerlor/multiplier-text

Add score multiplier on mods footer button

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

@@ -0,0 +1,92 @@
+// 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;
+using System.Collections.Generic;
+using System.Linq;
+using NUnit.Framework;
+using osu.Game.Graphics.Sprites;
+using osu.Game.Rulesets.Mods;
+using osu.Game.Rulesets.Osu.Mods;
+using osu.Game.Screens.Select;
+
+namespace osu.Game.Tests.Visual.UserInterface
+{
+    public class TestSceneFooterButtonMods : OsuTestScene
+    {
+        public override IReadOnlyList<Type> RequiredTypes => new[]
+        {
+            typeof(FooterButtonMods)
+        };
+
+        private readonly TestFooterButtonMods footerButtonMods;
+
+        public TestSceneFooterButtonMods()
+        {
+            Add(footerButtonMods = new TestFooterButtonMods());
+        }
+
+        [Test]
+        public void TestIncrementMultiplier()
+        {
+            var hiddenMod = new Mod[] { new OsuModHidden() };
+            AddStep(@"Add Hidden", () => changeMods(hiddenMod));
+            AddAssert(@"Check Hidden multiplier", () => assertModsMultiplier(hiddenMod));
+
+            var hardRockMod = new Mod[] { new OsuModHardRock() };
+            AddStep(@"Add HardRock", () => changeMods(hardRockMod));
+            AddAssert(@"Check HardRock multiplier", () => assertModsMultiplier(hardRockMod));
+
+            var doubleTimeMod = new Mod[] { new OsuModDoubleTime() };
+            AddStep(@"Add DoubleTime", () => changeMods(doubleTimeMod));
+            AddAssert(@"Check DoubleTime multiplier", () => assertModsMultiplier(doubleTimeMod));
+
+            var mutlipleIncrementMods = new Mod[] { new OsuModDoubleTime(), new OsuModHidden(), new OsuModHardRock() };
+            AddStep(@"Add multiple Mods", () => changeMods(mutlipleIncrementMods));
+            AddAssert(@"Check multiple mod multiplier", () => assertModsMultiplier(mutlipleIncrementMods));
+        }
+
+        [Test]
+        public void TestDecrementMultiplier()
+        {
+            var easyMod = new Mod[] { new OsuModEasy() };
+            AddStep(@"Add Easy", () => changeMods(easyMod));
+            AddAssert(@"Check Easy multiplier", () => assertModsMultiplier(easyMod));
+
+            var noFailMod = new Mod[] { new OsuModNoFail() };
+            AddStep(@"Add NoFail", () => changeMods(noFailMod));
+            AddAssert(@"Check NoFail multiplier", () => assertModsMultiplier(noFailMod));
+
+            var multipleDecrementMods = new Mod[] { new OsuModEasy(), new OsuModNoFail() };
+            AddStep(@"Add Multiple Mods", () => changeMods(multipleDecrementMods));
+            AddAssert(@"Check multiple mod multiplier", () => assertModsMultiplier(multipleDecrementMods));
+        }
+
+        [Test]
+        public void TestClearMultiplier()
+        {
+            var multipleMods = new Mod[] { new OsuModDoubleTime(), new OsuModFlashlight() };
+            AddStep(@"Add mods", () => changeMods(multipleMods));
+            AddStep(@"Clear selected mod", () => changeMods(Array.Empty<Mod>()));
+            AddAssert(@"Check empty multiplier", () => assertModsMultiplier(Array.Empty<Mod>()));
+        }
+
+        private void changeMods(IReadOnlyList<Mod> mods)
+        {
+            footerButtonMods.Current.Value = mods;
+        }
+
+        private bool assertModsMultiplier(IEnumerable<Mod> mods)
+        {
+            var multiplier = mods.Aggregate(1.0, (current, mod) => current * mod.ScoreMultiplier);
+            var expectedValue = multiplier.Equals(1.0) ? string.Empty : $"{multiplier:N2}x";
+
+            return expectedValue == footerButtonMods.MultiplierText.Text;
+        }
+
+        private class TestFooterButtonMods : FooterButtonMods
+        {
+            public new OsuSpriteText MultiplierText => base.MultiplierText;
+        }
+    }
+}

osu.Game/Screens/Select/FooterButtonMods.cs

@@ -7,11 +7,14 @@ using osu.Framework.Graphics.Containers;
 using osu.Game.Screens.Play.HUD;
 using osu.Game.Rulesets.Mods;
 using System.Collections.Generic;
+using System.Linq;
 using osu.Framework.Allocation;
 using osu.Framework.Extensions.Color4Extensions;
 using osu.Framework.Graphics.UserInterface;
 using osu.Game.Graphics;
+using osu.Game.Graphics.Sprites;
 using osuTK;
+using osuTK.Graphics;
 using osuTK.Input;
 
 namespace osu.Game.Screens.Select
@@ -24,19 +27,35 @@ namespace osu.Game.Screens.Select
             set => modDisplay.Current = value;
         }
 
+        protected readonly OsuSpriteText MultiplierText;
         private readonly FooterModDisplay modDisplay;
+        private Color4 lowMultiplierColour;
+        private Color4 highMultiplierColour;
 
         public FooterButtonMods()
         {
-            Add(new Container
+            Add(new FillFlowContainer
             {
                 Anchor = Anchor.CentreLeft,
                 Origin = Anchor.CentreLeft,
+                Direction = FillDirection.Horizontal,
                 Shear = -SHEAR,
-                Child = modDisplay = new FooterModDisplay
+                Children = new Drawable[]
                 {
-                    DisplayUnrankedText = false,
+                    modDisplay = new FooterModDisplay
-                    Scale = new Vector2(0.8f)
+                    {
+                        Anchor = Anchor.Centre,
+                        Origin = Anchor.Centre,
+                        DisplayUnrankedText = false,
+                        Scale = new Vector2(0.8f)
+                    },
+                    MultiplierText = new OsuSpriteText
+                    {
+                        Anchor = Anchor.Centre,
+                        Origin = Anchor.Centre,
+                        Font = OsuFont.GetFont(weight: FontWeight.Bold),
+                        Margin = new MarginPadding { Right = 10 }
+                    }
                 },
                 AutoSizeAxes = Axes.Both,
                 Margin = new MarginPadding { Left = 70 }
@@ -48,10 +67,33 @@ namespace osu.Game.Screens.Select
         {
             SelectedColour = colours.Yellow;
             DeselectedColour = SelectedColour.Opacity(0.5f);
+            lowMultiplierColour = colours.Red;
+            highMultiplierColour = colours.Green;
             Text = @"mods";
             Hotkey = Key.F1;
         }
 
+        protected override void LoadComplete()
+        {
+            base.LoadComplete();
+
+            Current.BindValueChanged(_ => updateMultiplierText(), true);
+        }
+
+        private void updateMultiplierText()
+        {
+            double multiplier = Current.Value?.Aggregate(1.0, (current, mod) => current * mod.ScoreMultiplier) ?? 1;
+
+            MultiplierText.Text = multiplier.Equals(1.0) ? string.Empty : $"{multiplier:N2}x";
+
+            if (multiplier > 1.0)
+                MultiplierText.FadeColour(highMultiplierColour, 200);
+            else if (multiplier < 1.0)
+                MultiplierText.FadeColour(lowMultiplierColour, 200);
+            else
+                MultiplierText.FadeColour(Color4.White, 200);
+        }
+
         private class FooterModDisplay : ModDisplay
         {
             public override bool ReceivePositionalInputAt(Vector2 screenSpacePos) => Parent?.Parent?.ReceivePositionalInputAt(screenSpacePos) ?? false;