// Copyright (c) ppy Pty Ltd . 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.Framework.Allocation; using osu.Framework.Bindables; using osu.Framework.Graphics; using osu.Game.Graphics.Sprites; using osu.Game.Graphics.UserInterface; using osu.Game.Overlays.Mods; using osu.Game.Overlays.Mods.Sections; using osu.Game.Rulesets; using osu.Game.Rulesets.Mania.Mods; using osu.Game.Rulesets.Mods; using osu.Game.Rulesets.Osu.Mods; using osu.Game.Rulesets.UI; using osu.Game.Screens.Play.HUD; using osuTK; using osuTK.Graphics; namespace osu.Game.Tests.Visual.UserInterface { [Description("mod select and icon display")] public class TestCaseMods : OsuTestCase { public override IReadOnlyList RequiredTypes => new[] { typeof(ModSelectOverlay), typeof(ModDisplay), typeof(ModSection), typeof(ModIcon), typeof(ModButton), typeof(ModButtonEmpty), typeof(DifficultyReductionSection), typeof(DifficultyIncreaseSection), typeof(AutomationSection), typeof(ConversionSection), typeof(FunSection), }; private RulesetStore rulesets; private ModDisplay modDisplay; private TestModSelectOverlay modSelect; [BackgroundDependencyLoader] private void load(RulesetStore rulesets) { this.rulesets = rulesets; Add(modSelect = new TestModSelectOverlay { RelativeSizeAxes = Axes.X, Origin = Anchor.BottomCentre, Anchor = Anchor.BottomCentre, }); Add(modDisplay = new ModDisplay { Anchor = Anchor.TopRight, Origin = Anchor.TopRight, AutoSizeAxes = Axes.Both, Position = new Vector2(0, 25), }); modDisplay.Current.UnbindBindings(); modDisplay.Current.BindTo(modSelect.SelectedMods); AddStep("Show", modSelect.Show); AddStep("Toggle", modSelect.ToggleVisibility); AddStep("Toggle", modSelect.ToggleVisibility); } [Test] public void TestOsuMods() { var ruleset = rulesets.AvailableRulesets.First(r => r.ID == 0); AddStep("change ruleset", () => { Ruleset.Value = ruleset; }); var instance = ruleset.CreateInstance(); var easierMods = instance.GetModsFor(ModType.DifficultyReduction); var harderMods = instance.GetModsFor(ModType.DifficultyIncrease); var assistMods = instance.GetModsFor(ModType.Automation); var noFailMod = easierMods.FirstOrDefault(m => m is OsuModNoFail); var hiddenMod = harderMods.FirstOrDefault(m => m is OsuModHidden); var doubleTimeMod = harderMods.OfType().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(easy, hardRock); testDeselectAll(easierMods.Where(m => !(m is MultiMod))); testMultiplierTextColour(noFailMod, modSelect.LowMultiplierColour); testMultiplierTextColour(hiddenMod, modSelect.HighMultiplierColour); testUnimplementedMod(autoPilotMod); } [Test] public void TestManiaMods() { var ruleset = rulesets.AvailableRulesets.First(r => r.ID == 3); AddStep("change ruleset", () => { Ruleset.Value = ruleset; }); testRankedText(ruleset.CreateInstance().GetModsFor(ModType.Conversion).First(m => m is ManiaModRandom)); } [Test] public void TestRulesetChanges() { var rulesetOsu = rulesets.AvailableRulesets.First(r => r.ID == 0); var rulesetMania = rulesets.AvailableRulesets.First(r => r.ID == 3); AddStep("change ruleset to null", () => { Ruleset.Value = null; }); var instance = rulesetOsu.CreateInstance(); var easierMods = instance.GetModsFor(ModType.DifficultyReduction); var noFailMod = easierMods.FirstOrDefault(m => m is OsuModNoFail); AddStep("set mods externally", () => { modDisplay.Current.Value = new[] { noFailMod }; }); AddStep("change ruleset to osu", () => { Ruleset.Value = rulesetOsu; }); AddAssert("ensure mods still selected", () => modDisplay.Current.Value.Single(m => m is OsuModNoFail) != null); AddStep("change ruleset to mania", () => { Ruleset.Value = rulesetMania; }); AddAssert("ensure mods not selected", () => !modDisplay.Current.Value.Any(m => m is OsuModNoFail)); AddStep("change ruleset to osu", () => { Ruleset.Value = rulesetOsu; }); AddAssert("ensure mods not selected", () => !modDisplay.Current.Value.Any()); } private void testSingleMod(Mod mod) { selectNext(mod); checkSelected(mod); selectPrevious(mod); checkNotSelected(mod); selectNext(mod); selectNext(mod); checkNotSelected(mod); selectPrevious(mod); selectPrevious(mod); checkNotSelected(mod); } private void testMultiMod(MultiMod multiMod) { foreach (var mod in multiMod.Mods) { selectNext(mod); checkSelected(mod); } for (int index = multiMod.Mods.Length - 1; index >= 0; index--) selectPrevious(multiMod.Mods[index]); foreach (var mod in multiMod.Mods) checkNotSelected(mod); } private void testUnimplementedMod(Mod mod) { selectNext(mod); checkNotSelected(mod); } private void testIncompatibleMods(Mod modA, Mod modB) { selectNext(modA); checkSelected(modA); checkNotSelected(modB); selectNext(modB); checkSelected(modB); checkNotSelected(modA); selectPrevious(modB); checkNotSelected(modA); checkNotSelected(modB); } private void testDeselectAll(IEnumerable mods) { foreach (var mod in mods) selectNext(mod); AddAssert("check for any selection", () => modSelect.SelectedMods.Value.Any()); AddStep("deselect all", modSelect.DeselectAllButton.Action.Invoke); AddAssert("check for no selection", () => !modSelect.SelectedMods.Value.Any()); } private void testMultiplierTextColour(Mod mod, Color4 colour) { checkLabelColor(Color4.White); selectNext(mod); AddWaitStep("wait for changing colour", 1); checkLabelColor(colour); selectPrevious(mod); AddWaitStep("wait for changing colour", 1); checkLabelColor(Color4.White); } private void testRankedText(Mod mod) { AddWaitStep("wait for fade", 1); AddAssert("check for ranked", () => modSelect.UnrankedLabel.Alpha == 0); selectNext(mod); AddWaitStep("wait for fade", 1); AddAssert("check for unranked", () => modSelect.UnrankedLabel.Alpha != 0); selectPrevious(mod); AddWaitStep("wait for fade", 1); AddAssert("check for ranked", () => modSelect.UnrankedLabel.Alpha == 0); } 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)?.SelectNext(-1)); private void checkSelected(Mod mod) { AddAssert($"check {mod.Name} is selected", () => { var button = modSelect.GetModButton(mod); return modSelect.SelectedMods.Value.Single(m => m.Name == mod.Name) != null && button.SelectedMod.GetType() == mod.GetType() && button.Selected; }); } private void checkNotSelected(Mod mod) { AddAssert($"check {mod.Name} is not selected", () => { var button = modSelect.GetModButton(mod); return modSelect.SelectedMods.Value.All(m => m.GetType() != mod.GetType()) && button.SelectedMod?.GetType() != mod.GetType(); }); } private void checkLabelColor(Color4 color) => AddAssert("check label has expected colour", () => modSelect.MultiplierLabel.Colour.AverageColour == color); private class TestModSelectOverlay : ModSelectOverlay { public new Bindable> SelectedMods => base.SelectedMods; public ModButton GetModButton(Mod mod) { var section = ModSectionsContainer.Children.Single(s => s.ModType == mod.Type); return section.ButtonsContainer.OfType().Single(b => b.Mods.Any(m => m.GetType() == mod.GetType())); } public new OsuSpriteText MultiplierLabel => base.MultiplierLabel; public new OsuSpriteText UnrankedLabel => base.UnrankedLabel; public new TriangleButton DeselectAllButton => base.DeselectAllButton; public new Color4 LowMultiplierColour => base.LowMultiplierColour; public new Color4 HighMultiplierColour => base.HighMultiplierColour; } } }