Merge branch 'master' into sample-control-points

osu.Game.Rulesets.Osu.Tests/TestSceneGameplayCursor.cs

@@ -8,6 +8,7 @@ using NUnit.Framework;
 using osu.Framework.Allocation;
 using osu.Framework.Audio.Sample;
 using osu.Framework.Bindables;
+using osu.Framework.Extensions.ObjectExtensions;
 using osu.Framework.Graphics;
 using osu.Framework.Graphics.Containers;
 using osu.Framework.Graphics.Shapes;
@@ -18,6 +19,7 @@ using osu.Framework.Testing.Input;
 using osu.Framework.Utils;
 using osu.Game.Audio;
 using osu.Game.Configuration;
+using osu.Game.Rulesets.Osu.Configuration;
 using osu.Game.Rulesets.Osu.Skinning;
 using osu.Game.Rulesets.Osu.UI.Cursor;
 using osu.Game.Screens.Play;
@@ -40,6 +42,8 @@ namespace osu.Game.Rulesets.Osu.Tests
 
         private Drawable background;
 
+        private readonly Bindable<bool> ripples = new Bindable<bool>();
+
         public TestSceneGameplayCursor()
         {
             var ruleset = new OsuRuleset();
@@ -57,6 +61,8 @@ namespace osu.Game.Rulesets.Osu.Tests
                 });
             });
 
+            AddToggleStep("ripples", v => ripples.Value = v);
+
             AddSliderStep("circle size", 0f, 10f, 0f, val =>
             {
                 config.SetValue(OsuSetting.AutoCursorSize, true);
@@ -67,6 +73,13 @@ namespace osu.Game.Rulesets.Osu.Tests
             AddStep("test cursor container", () => loadContent(false));
         }
 
+        [BackgroundDependencyLoader]
+        private void load()
+        {
+            var rulesetConfig = (OsuRulesetConfigManager)RulesetConfigs.GetConfigFor(Ruleset.Value.CreateInstance()).AsNonNull();
+            rulesetConfig.BindWith(OsuRulesetSetting.ShowCursorRipples, ripples);
+        }
+
         [TestCase(1, 1)]
         [TestCase(5, 1)]
         [TestCase(10, 1)]

osu.Game.Rulesets.Osu/Configuration/OsuRulesetConfigManager.cs

@@ -22,6 +22,7 @@ namespace osu.Game.Rulesets.Osu.Configuration
             SetDefault(OsuRulesetSetting.SnakingInSliders, true);
             SetDefault(OsuRulesetSetting.SnakingOutSliders, true);
             SetDefault(OsuRulesetSetting.ShowCursorTrail, true);
+            SetDefault(OsuRulesetSetting.ShowCursorRipples, false);
             SetDefault(OsuRulesetSetting.PlayfieldBorderStyle, PlayfieldBorderStyle.None);
         }
     }
@@ -31,6 +32,7 @@ namespace osu.Game.Rulesets.Osu.Configuration
         SnakingInSliders,
         SnakingOutSliders,
         ShowCursorTrail,
+        ShowCursorRipples,
         PlayfieldBorderStyle,
     }
 }

osu.Game.Rulesets.Osu/OsuSkinComponents.cs

@@ -10,6 +10,7 @@ namespace osu.Game.Rulesets.Osu
         Cursor,
         CursorTrail,
         CursorParticles,
+        CursorRipple,
         SliderScorePoint,
         ReverseArrow,
         HitCircleText,

osu.Game.Rulesets.Osu/Skinning/Legacy/OsuLegacySkinTransformer.cs

@@ -100,6 +100,28 @@ namespace osu.Game.Rulesets.Osu.Skinning.Legacy
 
                         return null;
 
+                    case OsuSkinComponents.CursorRipple:
+                        if (GetTexture("cursor-ripple") != null)
+                        {
+                            var ripple = this.GetAnimation("cursor-ripple", false, false);
+
+                            // In stable this element was scaled down to 50% and opacity 20%, but this makes the elements WAY too big and inflexible.
+                            // If anyone complains about these not being applied, this can be uncommented.
+                            //
+                            // But if no one complains I'd rather fix this in lazer. Wiki documentation doesn't mention size,
+                            // so we might be okay.
+                            //
+                            // if (ripple != null)
+                            // {
+                            //     ripple.Scale = new Vector2(0.5f);
+                            //     ripple.Alpha = 0.2f;
+                            // }
+
+                            return ripple;
+                        }
+
+                        return null;
+
                     case OsuSkinComponents.CursorParticles:
                         if (GetTexture("star2") != null)
                             return new LegacyCursorParticles();

osu.Game.Rulesets.Osu/UI/Cursor/CursorRippleVisualiser.cs

@@ -0,0 +1,105 @@
+// 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.Allocation;
+using osu.Framework.Bindables;
+using osu.Framework.Graphics;
+using osu.Framework.Graphics.Containers;
+using osu.Framework.Graphics.Pooling;
+using osu.Framework.Input.Bindings;
+using osu.Framework.Input.Events;
+using osu.Game.Rulesets.Osu.Configuration;
+using osu.Game.Rulesets.Osu.Objects;
+using osu.Game.Rulesets.Osu.Skinning.Default;
+using osu.Game.Skinning;
+using osuTK;
+
+namespace osu.Game.Rulesets.Osu.UI.Cursor
+{
+    public partial class CursorRippleVisualiser : CompositeDrawable, IKeyBindingHandler<OsuAction>
+    {
+        private readonly Bindable<bool> showRipples = new Bindable<bool>(true);
+
+        private readonly DrawablePool<CursorRipple> ripplePool = new DrawablePool<CursorRipple>(20);
+
+        public CursorRippleVisualiser()
+        {
+            RelativeSizeAxes = Axes.Both;
+        }
+
+        public Vector2 CursorScale { get; set; } = Vector2.One;
+
+        [BackgroundDependencyLoader(true)]
+        private void load(OsuRulesetConfigManager? rulesetConfig)
+        {
+            rulesetConfig?.BindWith(OsuRulesetSetting.ShowCursorRipples, showRipples);
+        }
+
+        public bool OnPressed(KeyBindingPressEvent<OsuAction> e)
+        {
+            if (showRipples.Value)
+            {
+                AddInternal(ripplePool.Get(r =>
+                {
+                    r.Position = e.MousePosition;
+                    r.Scale = CursorScale;
+                }));
+            }
+
+            return false;
+        }
+
+        public void OnReleased(KeyBindingReleaseEvent<OsuAction> e)
+        {
+        }
+
+        private partial class CursorRipple : PoolableDrawable
+        {
+            private Drawable ripple = null!;
+
+            [BackgroundDependencyLoader]
+            private void load()
+            {
+                AutoSizeAxes = Axes.Both;
+                Origin = Anchor.Centre;
+
+                InternalChild = ripple = new SkinnableDrawable(new OsuSkinComponentLookup(OsuSkinComponents.CursorRipple), _ => new DefaultCursorRipple())
+                {
+                    Blending = BlendingParameters.Additive,
+                };
+            }
+
+            protected override void PrepareForUse()
+            {
+                base.PrepareForUse();
+
+                ClearTransforms(true);
+
+                ripple.ScaleTo(0.1f)
+                      .ScaleTo(1, 700, Easing.Out);
+
+                this
+                    .FadeOutFromOne(700)
+                    .Expire(true);
+            }
+        }
+
+        public partial class DefaultCursorRipple : CompositeDrawable
+        {
+            [BackgroundDependencyLoader]
+            private void load()
+            {
+                AutoSizeAxes = Axes.Both;
+
+                InternalChildren = new Drawable[]
+                {
+                    new RingPiece(3)
+                    {
+                        Size = new Vector2(OsuHitObject.OBJECT_RADIUS * 2),
+                        Alpha = 0.1f,
+                    }
+                };
+            }
+        }
+    }
+}

osu.Game.Rulesets.Osu/UI/Cursor/OsuCursorContainer.cs

@@ -40,6 +40,8 @@ namespace osu.Game.Rulesets.Osu.UI.Cursor
         private Bindable<float> userCursorScale;
         private Bindable<bool> autoCursorScale;
 
+        private readonly CursorRippleVisualiser rippleVisualiser;
+
         public OsuCursorContainer()
         {
             InternalChild = fadeContainer = new Container
@@ -48,6 +50,7 @@ namespace osu.Game.Rulesets.Osu.UI.Cursor
                 Children = new[]
                 {
                     cursorTrail = new SkinnableDrawable(new OsuSkinComponentLookup(OsuSkinComponents.CursorTrail), _ => new DefaultCursorTrail(), confineMode: ConfineMode.NoScaling),
+                    rippleVisualiser = new CursorRippleVisualiser(),
                     new SkinnableDrawable(new OsuSkinComponentLookup(OsuSkinComponents.CursorParticles), confineMode: ConfineMode.NoScaling),
                 }
             };
@@ -82,6 +85,7 @@ namespace osu.Game.Rulesets.Osu.UI.Cursor
                 var newScale = new Vector2(e.NewValue);
 
                 ActiveCursor.Scale = newScale;
+                rippleVisualiser.CursorScale = newScale;
                 cursorTrail.Scale = newScale;
             }, true);
 

osu.Game.Rulesets.Osu/UI/OsuSettingsSubsection.cs

@@ -43,6 +43,11 @@ namespace osu.Game.Rulesets.Osu.UI
                     LabelText = RulesetSettingsStrings.CursorTrail,
                     Current = config.GetBindable<bool>(OsuRulesetSetting.ShowCursorTrail)
                 },
+                new SettingsCheckbox
+                {
+                    LabelText = RulesetSettingsStrings.CursorRipples,
+                    Current = config.GetBindable<bool>(OsuRulesetSetting.ShowCursorRipples)
+                },
                 new SettingsEnumDropdown<PlayfieldBorderStyle>
                 {
                     LabelText = RulesetSettingsStrings.PlayfieldBorderStyle,

osu.Game.Tests/Visual/Editing/TestSceneLocallyModifyingOnlineBeatmaps.cs

@@ -0,0 +1,37 @@
+// 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 NUnit.Framework;
+using osu.Framework.Extensions;
+using osu.Game.Database;
+using osu.Game.Tests.Resources;
+
+namespace osu.Game.Tests.Visual.Editing
+{
+    public partial class TestSceneLocallyModifyingOnlineBeatmaps : EditorSavingTestScene
+    {
+        public override void SetUpSteps()
+        {
+            CreateInitialBeatmap = () =>
+            {
+                var importedSet = Game.BeatmapManager.Import(new ImportTask(TestResources.GetTestBeatmapForImport())).GetResultSafely();
+                return Game.BeatmapManager.GetWorkingBeatmap(importedSet!.Value.Beatmaps.First());
+            };
+
+            base.SetUpSteps();
+        }
+
+        [Test]
+        public void TestLocallyModifyingOnlineBeatmap()
+        {
+            AddAssert("editor beatmap has online ID", () => EditorBeatmap.BeatmapInfo.OnlineID, () => Is.GreaterThan(0));
+
+            AddStep("delete first hitobject", () => EditorBeatmap.RemoveAt(0));
+            SaveEditor();
+
+            ReloadEditorToSameBeatmap();
+            AddAssert("editor beatmap online ID reset", () => EditorBeatmap.BeatmapInfo.OnlineID, () => Is.EqualTo(-1));
+        }
+    }
+}

osu.Game/Beatmaps/BeatmapManager.cs

@@ -415,6 +415,13 @@ namespace osu.Game.Beatmaps
             // All changes to metadata are made in the provided beatmapInfo, so this should be copied to the `IBeatmap` before encoding.
             beatmapContent.BeatmapInfo = beatmapInfo;
 
+            // Since now this is a locally-modified beatmap, we also set all relevant flags to indicate this.
+            // Importantly, the `ResetOnlineInfo()` call must happen before encoding, as online ID is encoded into the `.osu` file,
+            // which influences the beatmap checksums.
+            beatmapInfo.LastLocalUpdate = DateTimeOffset.Now;
+            beatmapInfo.Status = BeatmapOnlineStatus.LocallyModified;
+            beatmapInfo.ResetOnlineInfo();
+
             using (var stream = new MemoryStream())
             {
                 using (var sw = new StreamWriter(stream, Encoding.UTF8, 1024, true))
@@ -438,9 +445,6 @@ namespace osu.Game.Beatmaps
                 beatmapInfo.MD5Hash = stream.ComputeMD5Hash();
                 beatmapInfo.Hash = stream.ComputeSHA2Hash();
 
-                beatmapInfo.LastLocalUpdate = DateTimeOffset.Now;
-                beatmapInfo.Status = BeatmapOnlineStatus.LocallyModified;
-
                 AddFile(setInfo, stream, createBeatmapFilenameFromMetadata(beatmapInfo));
 
                 updateHashAndMarkDirty(setInfo);

osu.Game/Localisation/RulesetSettingsStrings.cs

@@ -29,6 +29,11 @@ namespace osu.Game.Localisation
         /// </summary>
         public static LocalisableString CursorTrail => new TranslatableString(getKey(@"cursor_trail"), @"Cursor trail");
 
+        /// <summary>
+        /// "Cursor ripples"
+        /// </summary>
+        public static LocalisableString CursorRipples => new TranslatableString(getKey(@"cursor_ripples"), @"Cursor ripples");
+
         /// <summary>
         /// "Playfield border style"
         /// </summary>

osu.Game/Rulesets/Edit/DistancedHitObjectComposer.cs

@@ -94,7 +94,7 @@ namespace osu.Game.Rulesets.Edit
 
         private (HitObject before, HitObject after)? getObjectsOnEitherSideOfCurrentTime()
         {
-            HitObject lastBefore = Playfield.HitObjectContainer.AliveObjects.LastOrDefault(h => h.HitObject.StartTime <= EditorClock.CurrentTime)?.HitObject;
+            HitObject lastBefore = Playfield.HitObjectContainer.AliveObjects.LastOrDefault(h => h.HitObject.StartTime < EditorClock.CurrentTime)?.HitObject;
 
             if (lastBefore == null)
                 return null;

osu.Game/Tests/Visual/EditorSavingTestScene.cs

@@ -3,9 +3,12 @@
 
 #nullable disable
 
+using System;
 using System.Linq;
+using JetBrains.Annotations;
 using osu.Framework.Input;
 using osu.Framework.Testing;
+using osu.Game.Beatmaps;
 using osu.Game.Rulesets.Edit;
 using osu.Game.Screens.Edit;
 using osu.Game.Screens.Edit.Setup;
@@ -24,18 +27,27 @@ namespace osu.Game.Tests.Visual
 
         protected EditorBeatmap EditorBeatmap => (EditorBeatmap)Editor.Dependencies.Get(typeof(EditorBeatmap));
 
+        [CanBeNull]
+        protected Func<WorkingBeatmap> CreateInitialBeatmap { get; set; }
+
         [SetUpSteps]
         public override void SetUpSteps()
         {
             base.SetUpSteps();
 
-            AddStep("set default beatmap", () => Game.Beatmap.SetDefault());
+            if (CreateInitialBeatmap == null)
+                AddStep("set default beatmap", () => Game.Beatmap.SetDefault());
+            else
+            {
+                AddStep("set test beatmap", () => Game.Beatmap.Value = CreateInitialBeatmap?.Invoke());
+            }
 
             PushAndConfirm(() => new EditorLoader());
 
             AddUntilStep("wait for editor load", () => Editor?.IsLoaded == true);
 
-            AddUntilStep("wait for metadata screen load", () => Editor.ChildrenOfType<MetadataSection>().FirstOrDefault()?.IsLoaded == true);
+            if (CreateInitialBeatmap == null)
+                AddUntilStep("wait for metadata screen load", () => Editor.ChildrenOfType<MetadataSection>().FirstOrDefault()?.IsLoaded == true);
 
             // We intentionally switch away from the metadata screen, else there is a feedback loop with the textbox handling which causes metadata changes below to get overwritten.
 
@@ -50,6 +62,14 @@ namespace osu.Game.Tests.Visual
 
         protected void ReloadEditorToSameBeatmap()
         {
+            Guid beatmapSetGuid = Guid.Empty;
+            Guid beatmapGuid = Guid.Empty;
+
+            AddStep("Store beatmap GUIDs", () =>
+            {
+                beatmapSetGuid = EditorBeatmap.BeatmapInfo.BeatmapSet!.ID;
+                beatmapGuid = EditorBeatmap.BeatmapInfo.ID;
+            });
             AddStep("Exit", () => InputManager.Key(Key.Escape));
 
             AddUntilStep("Wait for main menu", () => Game.ScreenStack.CurrentScreen is MainMenu);
@@ -59,7 +79,8 @@ namespace osu.Game.Tests.Visual
             PushAndConfirm(() => songSelect = new PlaySongSelect());
             AddUntilStep("wait for carousel load", () => songSelect.BeatmapSetsLoaded);
 
-            AddUntilStep("Wait for beatmap selected", () => !Game.Beatmap.IsDefault);
+            AddStep("Present same beatmap", () => Game.PresentBeatmap(Game.BeatmapManager.QueryBeatmapSet(set => set.ID == beatmapSetGuid)!.Value, beatmap => beatmap.ID == beatmapGuid));
+            AddUntilStep("Wait for beatmap selected", () => Game.Beatmap.Value.BeatmapInfo.ID == beatmapGuid);
             AddStep("Open options", () => InputManager.Key(Key.F3));
             AddStep("Enter editor", () => InputManager.Key(Key.Number5));