From 9d28d5f8ee5472356d6ef5fb2a992965b656d751 Mon Sep 17 00:00:00 2001
From: Jamie Taylor <me@nekodex.net>
Date: Fri, 1 Jul 2022 20:43:12 +0900
Subject: [PATCH] Update SFX for mod overlay show/hide

---
 osu.Game/Overlays/Mods/ModSelectOverlay.cs | 39 ++++++++++++++++++++--
 1 file changed, 36 insertions(+), 3 deletions(-)

diff --git a/osu.Game/Overlays/Mods/ModSelectOverlay.cs b/osu.Game/Overlays/Mods/ModSelectOverlay.cs
index 69cb3a49fc..bf5200902c 100644
--- a/osu.Game/Overlays/Mods/ModSelectOverlay.cs
+++ b/osu.Game/Overlays/Mods/ModSelectOverlay.cs
@@ -6,6 +6,8 @@ using System.Collections.Generic;
 using System.Diagnostics;
 using System.Linq;
 using osu.Framework.Allocation;
+using osu.Framework.Audio;
+using osu.Framework.Audio.Sample;
 using osu.Framework.Bindables;
 using osu.Framework.Graphics;
 using osu.Framework.Graphics.Containers;
@@ -28,6 +30,9 @@ namespace osu.Game.Overlays.Mods
     {
         public const int BUTTON_WIDTH = 200;
 
+        protected override string PopInSampleName => "";
+        protected override string PopOutSampleName => @"SongSelect/mod-select-overlay-pop-out";
+
         [Cached]
         public Bindable<IReadOnlyList<Mod>> SelectedMods { get; private set; } = new Bindable<IReadOnlyList<Mod>>(Array.Empty<Mod>());
 
@@ -101,17 +106,21 @@ namespace osu.Game.Overlays.Mods
 
         private ShearedToggleButton? customisationButton;
 
+        private Sample? columnAppearSample;
+
         protected ModSelectOverlay(OverlayColourScheme colourScheme = OverlayColourScheme.Green)
             : base(colourScheme)
         {
         }
 
         [BackgroundDependencyLoader]
-        private void load(OsuGameBase game, OsuColour colours)
+        private void load(OsuGameBase game, OsuColour colours, AudioManager audio)
         {
             Header.Title = ModSelectOverlayStrings.ModSelectTitle;
             Header.Description = ModSelectOverlayStrings.ModSelectDescription;
 
+            columnAppearSample = audio.Samples.Get(@"SongSelect/mod-column-pop-in");
+
             AddRange(new Drawable[]
             {
                 new ClickToReturnContainer
@@ -453,8 +462,32 @@ namespace osu.Game.Overlays.Mods
                       .MoveToY(0, duration, Easing.OutQuint)
                       .FadeIn(duration, Easing.OutQuint);
 
-                if (!allFiltered)
-                    nonFilteredColumnCount += 1;
+                if (allFiltered)
+                    continue;
+
+                int columnNumber = nonFilteredColumnCount;
+                Scheduler.AddDelayed(() =>
+                {
+                    var channel = columnAppearSample?.GetChannel();
+                    if (channel == null) return;
+
+                    // don't play sample if column isn't visible, but try to play it at least 5 times (assuming there's at least 5 visible columns in `columnFlow`)
+                    if (columnNumber > 5 && !column.Active.Value) return;
+
+                    // use X position of the column on screen as a basis for panning the sample
+                    var bounds = column.Parent.BoundingBox;
+                    float balance = (bounds.TopLeft.X + bounds.Width / 2) / RelativeToAbsoluteFactor.X;
+
+                    // dip frequency and ramp volume of sample over the first 5 displayed columns
+                    float progress = Math.Min(1, columnNumber / 5f);
+
+                    channel.Frequency.Value = 1.3 - (progress * 0.3) + RNG.NextDouble(0.1);
+                    channel.Volume.Value = Math.Max(progress, 0.2);
+                    channel.Balance.Value = -1 + balance * 2;
+                    channel.Play();
+                }, delay);
+
+                nonFilteredColumnCount += 1;
             }
         }