Merge branch 'master' into spun-out

osu.Game.Rulesets.Catch/Mods/CatchModDifficultyAdjust.cs

@@ -1,6 +1,7 @@
 // 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.Linq;
 using osu.Framework.Bindables;
 using osu.Game.Beatmaps;
 using osu.Game.Configuration;
@@ -30,6 +31,22 @@ namespace osu.Game.Rulesets.Catch.Mods
             Value = 5,
         };
 
+        public override string SettingDescription
+        {
+            get
+            {
+                string circleSize = CircleSize.IsDefault ? string.Empty : $"CS {CircleSize.Value:N1}";
+                string approachRate = ApproachRate.IsDefault ? string.Empty : $"AR {ApproachRate.Value:N1}";
+
+                return string.Join(", ", new[]
+                {
+                    circleSize,
+                    base.SettingDescription,
+                    approachRate
+                }.Where(s => !string.IsNullOrEmpty(s)));
+            }
+        }
+
         protected override void TransferSettings(BeatmapDifficulty difficulty)
         {
             base.TransferSettings(difficulty);

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

@@ -1,6 +1,7 @@
 // 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.Linq;
 using osu.Framework.Bindables;
 using osu.Game.Beatmaps;
 using osu.Game.Configuration;
@@ -30,6 +31,22 @@ namespace osu.Game.Rulesets.Osu.Mods
             Value = 5,
         };
 
+        public override string SettingDescription
+        {
+            get
+            {
+                string circleSize = CircleSize.IsDefault ? string.Empty : $"CS {CircleSize.Value:N1}";
+                string approachRate = ApproachRate.IsDefault ? string.Empty : $"AR {ApproachRate.Value:N1}";
+
+                return string.Join(", ", new[]
+                {
+                    circleSize,
+                    base.SettingDescription,
+                    approachRate
+                }.Where(s => !string.IsNullOrEmpty(s)));
+            }
+        }
+
         protected override void TransferSettings(BeatmapDifficulty difficulty)
         {
             base.TransferSettings(difficulty);

osu.Game.Tests/Visual/Gameplay/TestSceneAllRulesetPlayers.cs

@@ -4,7 +4,6 @@
 using System.Linq;
 using NUnit.Framework;
 using osu.Framework.Allocation;
-using osu.Framework.Screens;
 using osu.Game.Configuration;
 using osu.Game.Rulesets;
 using osu.Game.Rulesets.Catch;
@@ -74,9 +73,6 @@ namespace osu.Game.Tests.Visual.Gameplay
             Beatmap.Value = working;
             SelectedMods.Value = new[] { ruleset.GetAllMods().First(m => m is ModNoFail) };
 
-            Player?.Exit();
-            Player = null;
-
             Player = CreatePlayer(ruleset);
 
             LoadScreen(Player);

osu.Game.Tests/Visual/Gameplay/TestSceneAutoplay.cs

@@ -4,9 +4,13 @@
 using System.ComponentModel;
 using System.Linq;
 using osu.Framework.Testing;
+using osu.Game.Beatmaps.Timing;
 using osu.Game.Rulesets;
+using osu.Game.Rulesets.Objects;
+using osu.Game.Rulesets.Scoring;
 using osu.Game.Screens.Play;
 using osu.Game.Screens.Play.Break;
+using osu.Game.Screens.Ranking;
 
 namespace osu.Game.Tests.Visual.Gameplay
 {
@@ -17,21 +21,38 @@ namespace osu.Game.Tests.Visual.Gameplay
 
         protected override Player CreatePlayer(Ruleset ruleset)
         {
-            SelectedMods.Value = SelectedMods.Value.Concat(new[] { ruleset.GetAutoplayMod() }).ToArray();
-            return new TestPlayer(false, false);
+            SelectedMods.Value = new[] { ruleset.GetAutoplayMod() };
+            return new TestPlayer(false);
         }
 
         protected override void AddCheckSteps()
         {
             AddUntilStep("score above zero", () => Player.ScoreProcessor.TotalScore.Value > 0);
             AddUntilStep("key counter counted keys", () => Player.HUDOverlay.KeyCounter.Children.Any(kc => kc.CountPresses > 2));
-            AddStep("seek to break time", () => Player.GameplayClockContainer.Seek(Player.ChildrenOfType<BreakTracker>().First().Breaks.First().StartTime));
-            AddUntilStep("wait for seek to complete", () =>
-                Player.HUDOverlay.Progress.ReferenceClock.CurrentTime >= Player.BreakOverlay.Breaks.First().StartTime);
+            seekToBreak(0);
             AddAssert("keys not counting", () => !Player.HUDOverlay.KeyCounter.IsCounting);
             AddAssert("overlay displays 100% accuracy", () => Player.BreakOverlay.ChildrenOfType<BreakInfo>().Single().AccuracyDisplay.Current.Value == 1);
             AddStep("rewind", () => Player.GameplayClockContainer.Seek(-80000));
             AddUntilStep("key counter reset", () => Player.HUDOverlay.KeyCounter.Children.All(kc => kc.CountPresses == 0));
+
+            seekToBreak(0);
+            seekToBreak(1);
+
+            AddStep("seek to completion", () => Player.GameplayClockContainer.Seek(Player.DrawableRuleset.Objects.Last().GetEndTime()));
+            AddUntilStep("results displayed", () => getResultsScreen() != null);
+
+            AddAssert("score has combo", () => getResultsScreen().Score.Combo > 100);
+            AddAssert("score has no misses", () => getResultsScreen().Score.Statistics[HitResult.Miss] == 0);
+
+            ResultsScreen getResultsScreen() => Stack.CurrentScreen as ResultsScreen;
+        }
+
+        private void seekToBreak(int breakIndex)
+        {
+            AddStep($"seek to break {breakIndex}", () => Player.GameplayClockContainer.Seek(destBreak().StartTime));
+            AddUntilStep("wait for seek to complete", () => Player.HUDOverlay.Progress.ReferenceClock.CurrentTime >= destBreak().StartTime);
+
+            BreakPeriod destBreak() => Player.ChildrenOfType<BreakTracker>().First().Breaks.ElementAt(breakIndex);
         }
     }
 }

osu.Game.Tests/Visual/Gameplay/TestSceneReplayRecorder.cs

@@ -17,13 +17,12 @@ using osu.Game.Replays;
 using osu.Game.Rulesets;
 using osu.Game.Rulesets.Replays;
 using osu.Game.Rulesets.UI;
-using osu.Game.Tests.Visual;
 using osu.Game.Tests.Visual.UserInterface;
 using osuTK;
 using osuTK.Graphics;
 using osuTK.Input;
 
-namespace osu.Game.Tests.Gameplay
+namespace osu.Game.Tests.Visual.Gameplay
 {
     public class TestSceneReplayRecorder : OsuManualInputManagerTestScene
     {

osu.Game.Tests/Visual/Gameplay/TestSceneReplayRecording.cs

@@ -13,12 +13,11 @@ using osu.Game.Replays;
 using osu.Game.Rulesets;
 using osu.Game.Rulesets.Replays;
 using osu.Game.Rulesets.UI;
-using osu.Game.Tests.Visual;
 using osu.Game.Tests.Visual.UserInterface;
 using osuTK;
 using osuTK.Graphics;
 
-namespace osu.Game.Tests.Gameplay
+namespace osu.Game.Tests.Visual.Gameplay
 {
     public class TestSceneReplayRecording : OsuTestScene
     {

osu.Game.Tests/Visual/SongSelect/TestSceneBeatmapCarousel.cs

@@ -83,6 +83,82 @@ namespace osu.Game.Tests.Visual.SongSelect
             waitForSelection(set_count, 3);
         }
 
+        [TestCase(true)]
+        [TestCase(false)]
+        public void TestTraversalBeyondVisible(bool forwards)
+        {
+            var sets = new List<BeatmapSetInfo>();
+
+            const int total_set_count = 200;
+
+            for (int i = 0; i < total_set_count; i++)
+                sets.Add(createTestBeatmapSet(i + 1));
+
+            loadBeatmaps(sets);
+
+            for (int i = 1; i < total_set_count; i += i)
+                selectNextAndAssert(i);
+
+            void selectNextAndAssert(int amount)
+            {
+                setSelected(forwards ? 1 : total_set_count, 1);
+
+                AddStep($"{(forwards ? "Next" : "Previous")} beatmap {amount} times", () =>
+                {
+                    for (int i = 0; i < amount; i++)
+                    {
+                        carousel.SelectNext(forwards ? 1 : -1);
+                    }
+                });
+
+                waitForSelection(forwards ? amount + 1 : total_set_count - amount);
+            }
+        }
+
+        [Test]
+        public void TestTraversalBeyondVisibleDifficulties()
+        {
+            var sets = new List<BeatmapSetInfo>();
+
+            const int total_set_count = 20;
+
+            for (int i = 0; i < total_set_count; i++)
+                sets.Add(createTestBeatmapSet(i + 1));
+
+            loadBeatmaps(sets);
+
+            // Selects next set once, difficulty index doesn't change
+            selectNextAndAssert(3, true, 2, 1);
+
+            // Selects next set 16 times (50 \ 3 == 16), difficulty index changes twice (50 % 3 == 2)
+            selectNextAndAssert(50, true, 17, 3);
+
+            // Travels around the carousel thrice (200 \ 60 == 3)
+            // continues to select 20 times (200 \ 60 == 20)
+            // selects next set 6 times (20 \ 3 == 6)
+            // difficulty index changes twice (20 % 3 == 2)
+            selectNextAndAssert(200, true, 7, 3);
+
+            // All same but in reverse
+            selectNextAndAssert(3, false, 19, 3);
+            selectNextAndAssert(50, false, 4, 1);
+            selectNextAndAssert(200, false, 14, 1);
+
+            void selectNextAndAssert(int amount, bool forwards, int expectedSet, int expectedDiff)
+            {
+                // Select very first or very last difficulty
+                setSelected(forwards ? 1 : 20, forwards ? 1 : 3);
+
+                AddStep($"{(forwards ? "Next" : "Previous")} difficulty {amount} times", () =>
+                {
+                    for (int i = 0; i < amount; i++)
+                        carousel.SelectNext(forwards ? 1 : -1, false);
+                });
+
+                waitForSelection(expectedSet, expectedDiff);
+            }
+        }
+
         /// <summary>
         /// Test filtering
         /// </summary>

osu.Game/Rulesets/Mods/Mod.cs

@@ -2,9 +2,15 @@
 // See the LICENCE file in the repository root for full licence text.
 
 using System;
+using System.Collections.Generic;
+using System.Linq;
+using System.Reflection;
 using Newtonsoft.Json;
+using osu.Framework.Bindables;
 using osu.Framework.Graphics.Sprites;
+using osu.Game.Configuration;
 using osu.Game.IO.Serialization;
+using osu.Game.Rulesets.UI;
 
 namespace osu.Game.Rulesets.Mods
 {
@@ -42,6 +48,51 @@ namespace osu.Game.Rulesets.Mods
         [JsonIgnore]
         public virtual string Description => string.Empty;
 
+        /// <summary>
+        /// The tooltip to display for this mod when used in a <see cref="ModIcon"/>.
+        /// </summary>
+        /// <remarks>
+        /// Differs from <see cref="Name"/>, as the value of attributes (AR, CS, etc) changeable via the mod
+        /// are displayed in the tooltip.
+        /// </remarks>
+        [JsonIgnore]
+        public string IconTooltip
+        {
+            get
+            {
+                string description = SettingDescription;
+
+                return string.IsNullOrEmpty(description) ? Name : $"{Name} ({description})";
+            }
+        }
+
+        /// <summary>
+        /// The description of editable settings of a mod to use in the <see cref="IconTooltip"/>.
+        /// </summary>
+        /// <remarks>
+        /// Parentheses are added to the tooltip, surrounding the value of this property. If this property is <c>string.Empty</c>,
+        /// the tooltip will not have parentheses.
+        /// </remarks>
+        public virtual string SettingDescription
+        {
+            get
+            {
+                var tooltipTexts = new List<string>();
+
+                foreach ((SettingSourceAttribute attr, PropertyInfo property) in this.GetOrderedSettingsSourceProperties())
+                {
+                    object bindableObj = property.GetValue(this);
+
+                    if ((bindableObj as IHasDefaultValue)?.IsDefault == true)
+                        continue;
+
+                    tooltipTexts.Add($"{attr.Label} {bindableObj}");
+                }
+
+                return string.Join(", ", tooltipTexts.Where(s => !string.IsNullOrEmpty(s)));
+            }
+        }
+
         /// <summary>
         /// The score multiplier of this mod.
         /// </summary>

osu.Game/Rulesets/Mods/ModDifficultyAdjust.cs

@@ -7,6 +7,7 @@ using osu.Framework.Graphics.Sprites;
 using System;
 using System.Collections.Generic;
 using osu.Game.Configuration;
+using System.Linq;
 
 namespace osu.Game.Rulesets.Mods
 {
@@ -52,6 +53,21 @@ namespace osu.Game.Rulesets.Mods
             Value = 5,
         };
 
+        public override string SettingDescription
+        {
+            get
+            {
+                string drainRate = DrainRate.IsDefault ? string.Empty : $"HP {DrainRate.Value:N1}";
+                string overallDifficulty = OverallDifficulty.IsDefault ? string.Empty : $"OD {OverallDifficulty.Value:N1}";
+
+                return string.Join(", ", new[]
+                {
+                    drainRate,
+                    overallDifficulty
+                }.Where(s => !string.IsNullOrEmpty(s)));
+            }
+        }
+
         private BeatmapDifficulty difficulty;
 
         public void ReadFromDifficulty(BeatmapDifficulty difficulty)
@@ -79,7 +95,7 @@ namespace osu.Game.Rulesets.Mods
 
         /// <summary>
         /// Transfer a setting from <see cref="BeatmapDifficulty"/> to a configuration bindable.
-        /// Only performs the transfer if the user it not currently overriding..
+        /// Only performs the transfer if the user is not currently overriding.
         /// </summary>
         protected void TransferSetting<T>(BindableNumber<T> bindable, T beatmapDefault)
             where T : struct, IComparable<T>, IConvertible, IEquatable<T>

osu.Game/Rulesets/Mods/ModEasy.cs

@@ -2,6 +2,7 @@
 // See the LICENCE file in the repository root for full licence text.
 
 using System;
+using Humanizer;
 using osu.Framework.Bindables;
 using osu.Framework.Graphics.Sprites;
 using osu.Game.Beatmaps;
@@ -28,6 +29,8 @@ namespace osu.Game.Rulesets.Mods
             MaxValue = 10
         };
 
+        public override string SettingDescription => Retries.IsDefault ? string.Empty : $"{"lives".ToQuantity(Retries.Value)}";
+
         private int retries;
 
         private BindableNumber<double> health;

osu.Game/Rulesets/Mods/ModRateAdjust.cs

@@ -15,5 +15,7 @@ namespace osu.Game.Rulesets.Mods
         {
             track.AddAdjustment(AdjustableProperty.Tempo, SpeedChange);
         }
+
+        public override string SettingDescription => SpeedChange.IsDefault ? string.Empty : $"{SpeedChange.Value:N2}x";
     }
 }

osu.Game/Rulesets/Mods/ModTimeRamp.cs

@@ -26,6 +26,8 @@ namespace osu.Game.Rulesets.Mods
         [SettingSource("Final rate", "The final speed to ramp to")]
         public abstract BindableNumber<double> FinalRate { get; }
 
+        public override string SettingDescription => $"{InitialRate.Value:N2}x to {FinalRate.Value:N2}x";
+
         private double finalRateTime;
         private double beginRampTime;
 

osu.Game/Rulesets/UI/ModIcon.cs

@@ -28,7 +28,7 @@ namespace osu.Game.Rulesets.UI
 
         private readonly ModType type;
 
-        public virtual string TooltipText { get; }
+        public virtual string TooltipText => mod.IconTooltip;
 
         private Mod mod;
 
@@ -48,8 +48,6 @@ namespace osu.Game.Rulesets.UI
 
             type = mod.Type;
 
-            TooltipText = mod.Name;
-
             Size = new Vector2(size);
 
             Children = new Drawable[]

osu.Game/Screens/Play/Player.cs

@@ -637,6 +637,39 @@ namespace osu.Game.Screens.Play
             return base.OnExiting(next);
         }
 
+        protected virtual void GotoRanking()
+        {
+            if (DrawableRuleset.ReplayScore != null)
+            {
+                // if a replay is present, we likely don't want to import into the local database.
+                this.Push(CreateResults(CreateScore()));
+                return;
+            }
+
+            LegacyByteArrayReader replayReader = null;
+
+            var score = new Score { ScoreInfo = CreateScore() };
+
+            if (recordingReplay?.Frames.Count > 0)
+            {
+                score.Replay = recordingReplay;
+
+                using (var stream = new MemoryStream())
+                {
+                    new LegacyScoreEncoder(score, gameplayBeatmap.PlayableBeatmap).Encode(stream);
+                    replayReader = new LegacyByteArrayReader(stream.ToArray(), "replay.osr");
+                }
+            }
+
+            scoreManager.Import(score.ScoreInfo, replayReader)
+                        .ContinueWith(imported => Schedule(() =>
+                        {
+                            // screen may be in the exiting transition phase.
+                            if (this.IsCurrentScreen())
+                                this.Push(CreateResults(imported.Result));
+                        }));
+        }
+
         private void fadeOut(bool instant = false)
         {
             float fadeOutDuration = instant ? 0 : 250;
@@ -649,36 +682,7 @@ namespace osu.Game.Screens.Play
         private void scheduleGotoRanking()
         {
             completionProgressDelegate?.Cancel();
-            completionProgressDelegate = Schedule(delegate
-            {
-                if (DrawableRuleset.ReplayScore != null)
-                    this.Push(CreateResults(DrawableRuleset.ReplayScore.ScoreInfo));
-                else
-                {
-                    var score = new Score { ScoreInfo = CreateScore() };
-
-                    LegacyByteArrayReader replayReader = null;
-
-                    if (recordingReplay?.Frames.Count > 0)
-                    {
-                        score.Replay = recordingReplay;
-
-                        using (var stream = new MemoryStream())
-                        {
-                            new LegacyScoreEncoder(score, gameplayBeatmap.PlayableBeatmap).Encode(stream);
-                            replayReader = new LegacyByteArrayReader(stream.ToArray(), "replay.osr");
-                        }
-                    }
-
-                    scoreManager.Import(score.ScoreInfo, replayReader)
-                                .ContinueWith(imported => Schedule(() =>
-                                {
-                                    // screen may be in the exiting transition phase.
-                                    if (this.IsCurrentScreen())
-                                        this.Push(CreateResults(imported.Result));
-                                }));
-                }
-            });
+            completionProgressDelegate = Schedule(GotoRanking);
         }
 
         #endregion

osu.Game/Screens/Play/ReplayPlayer.cs

@@ -1,6 +1,7 @@
 // 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 osu.Framework.Screens;
 using osu.Game.Scoring;
 
 namespace osu.Game.Screens.Play
@@ -23,6 +24,11 @@ namespace osu.Game.Screens.Play
             DrawableRuleset?.SetReplayScore(score);
         }
 
+        protected override void GotoRanking()
+        {
+            this.Push(CreateResults(DrawableRuleset.ReplayScore.ScoreInfo));
+        }
+
         protected override ScoreInfo CreateScore() => score.ScoreInfo;
     }
 }

osu.Game/Screens/Ranking/ResultsScreen.cs

@@ -31,13 +31,13 @@ namespace osu.Game.Screens.Ranking
         [Resolved(CanBeNull = true)]
         private Player player { get; set; }
 
-        private readonly ScoreInfo score;
+        public readonly ScoreInfo Score;
 
         private Drawable bottomPanel;
 
         public ResultsScreen(ScoreInfo score)
         {
-            this.score = score;
+            Score = score;
         }
 
         [BackgroundDependencyLoader]
@@ -47,7 +47,7 @@ namespace osu.Game.Screens.Ranking
             {
                 new ResultsScrollContainer
                 {
-                    Child = new ScorePanel(score)
+                    Child = new ScorePanel(Score)
                     {
                         Anchor = Anchor.Centre,
                         Origin = Anchor.Centre,
@@ -77,7 +77,7 @@ namespace osu.Game.Screens.Ranking
                             Direction = FillDirection.Horizontal,
                             Children = new Drawable[]
                             {
-                                new ReplayDownloadButton(score) { Width = 300 },
+                                new ReplayDownloadButton(Score) { Width = 300 },
                                 new RetryButton { Width = 300 },
                             }
                         }

osu.Game/Screens/Select/BeatmapCarousel.cs

@@ -253,46 +253,37 @@ namespace osu.Game.Screens.Select
         /// <param name="skipDifficulties">Whether to skip individual difficulties and only increment over full groups.</param>
         public void SelectNext(int direction = 1, bool skipDifficulties = true)
         {
-            var visibleItems = Items.Where(s => !s.Item.Filtered.Value).ToList();
-
-            if (!visibleItems.Any())
+            if (beatmapSets.All(s => s.Filtered.Value))
                 return;
 
-            DrawableCarouselItem drawable = null;
+            if (skipDifficulties)
+                selectNextSet(direction, true);
+            else
+                selectNextDifficulty(direction);
+        }
 
-            if (selectedBeatmap != null && (drawable = selectedBeatmap.Drawables.FirstOrDefault()) == null)
-                // if the selected beatmap isn't present yet, we can't correctly change selection.
-                // we can fix this by changing this method to not reference drawables / Items in the first place.
-                return;
+        private void selectNextSet(int direction, bool skipDifficulties)
+        {
+            var unfilteredSets = beatmapSets.Where(s => !s.Filtered.Value).ToList();
 
-            int originalIndex = visibleItems.IndexOf(drawable);
-            int currentIndex = originalIndex;
+            var nextSet = unfilteredSets[(unfilteredSets.IndexOf(selectedBeatmapSet) + direction + unfilteredSets.Count) % unfilteredSets.Count];
 
-            // local function to increment the index in the required direction, wrapping over extremities.
-            int incrementIndex() => currentIndex = (currentIndex + direction + visibleItems.Count) % visibleItems.Count;
+            if (skipDifficulties)
+                select(nextSet);
+            else
+                select(direction > 0 ? nextSet.Beatmaps.First(b => !b.Filtered.Value) : nextSet.Beatmaps.Last(b => !b.Filtered.Value));
+        }
 
-            while (incrementIndex() != originalIndex)
-            {
-                var item = visibleItems[currentIndex].Item;
+        private void selectNextDifficulty(int direction)
+        {
+            var unfilteredDifficulties = selectedBeatmapSet.Children.Where(s => !s.Filtered.Value).ToList();
 
-                if (item.Filtered.Value || item.State.Value == CarouselItemState.Selected) continue;
+            int index = unfilteredDifficulties.IndexOf(selectedBeatmap);
 
-                switch (item)
-                {
-                    case CarouselBeatmap beatmap:
-                        if (skipDifficulties) continue;
-
-                        select(beatmap);
-                        return;
-
-                    case CarouselBeatmapSet set:
-                        if (skipDifficulties)
-                            select(set);
-                        else
-                            select(direction > 0 ? set.Beatmaps.First(b => !b.Filtered.Value) : set.Beatmaps.Last(b => !b.Filtered.Value));
-                        return;
-                }
-            }
+            if (index + direction < 0 || index + direction >= unfilteredDifficulties.Count)
+                selectNextSet(direction, false);
+            else
+                select(unfilteredDifficulties[index + direction]);
         }
 
         /// <summary>