Merge pull request #30910 from nekodex/improve-menu-sample-playback

peppy · web-flow · commit 7592813e5618 · 2024-12-05T20:50:14.000-08:00
Improve menu/context-menu sample playback
diff --git a/osu.Android.props b/osu.Android.props
@@ -10,7 +10,7 @@
     <EmbedAssembliesIntoApk>true</EmbedAssembliesIntoApk>
   </PropertyGroup>
   <ItemGroup>
-    <PackageReference Include="ppy.osu.Framework.Android" Version="2024.1128.0" />
+    <PackageReference Include="ppy.osu.Framework.Android" Version="2024.1205.0" />
   </ItemGroup>
   <PropertyGroup>
     <!-- Fody does not handle Android build well, and warns when unchanged.
diff --git a/osu.Game.Tests/Visual/UserInterface/TestSceneContextMenu.cs b/osu.Game.Tests/Visual/UserInterface/TestSceneContextMenu.cs
@@ -101,7 +101,16 @@ private static MenuItem[] makeMenu()
                                     }
                                 }
                             }
-                        }
+                        },
+                    }
+                },
+                new OsuMenuItem(@"Another nested option")
+                {
+                    Items = new MenuItem[]
+                    {
+                        new OsuMenuItem(@"Sub-One"),
+                        new OsuMenuItem(@"Sub-Two"),
+                        new OsuMenuItem(@"Sub-Three"),
                     }
                 },
                 new OsuMenuItem(@"Choose me please"),
diff --git a/osu.Game/Graphics/Cursor/OsuContextMenuContainer.cs b/osu.Game/Graphics/Cursor/OsuContextMenuContainer.cs
@@ -11,16 +11,8 @@ namespace osu.Game.Graphics.Cursor
     [Cached(typeof(OsuContextMenuContainer))]
     public partial class OsuContextMenuContainer : ContextMenuContainer
     {
-        [Cached]
-        private OsuContextMenuSamples samples = new OsuContextMenuSamples();
-
         private OsuContextMenu menu = null!;
 
-        public OsuContextMenuContainer()
-        {
-            AddInternal(samples);
-        }
-
         protected override Menu CreateMenu() => menu = new OsuContextMenu(true);
 
         public void CloseMenu()
diff --git a/osu.Game/Graphics/UserInterface/HoverSampleSet.cs b/osu.Game/Graphics/UserInterface/HoverSampleSet.cs
@@ -23,6 +23,9 @@ public enum HoverSampleSet
         DialogCancel,
 
         [Description("dialog-ok")]
-        DialogOk
+        DialogOk,
+
+        [Description("menu-open")]
+        MenuOpen,
     }
 }
diff --git a/osu.Game/Graphics/UserInterface/OsuContextMenu.cs b/osu.Game/Graphics/UserInterface/OsuContextMenu.cs
@@ -15,7 +15,7 @@ public partial class OsuContextMenu : OsuMenu
         private const int fade_duration = 250;
 
         [Resolved]
-        private OsuContextMenuSamples samples { get; set; } = null!;
+        private OsuMenuSamples menuSamples { get; set; } = null!;
 
         // todo: this shouldn't be required after https://github.com/ppy/osu-framework/issues/4519 is fixed.
         private bool wasOpened;
@@ -47,23 +47,22 @@ private void load(OsuColour colours)
 
         protected override void AnimateOpen()
         {
+            wasOpened = true;
             this.FadeIn(fade_duration, Easing.OutQuint);
 
-            if (playClickSample)
-                samples.PlayClickSample();
-
-            if (!wasOpened)
-                samples.PlayOpenSample();
+            if (!playClickSample)
+                return;
 
-            wasOpened = true;
+            menuSamples.PlayClickSample();
+            menuSamples.PlayOpenSample();
         }
 
         protected override void AnimateClose()
         {
             this.FadeOut(fade_duration, Easing.OutQuint);
 
             if (wasOpened)
-                samples.PlayCloseSample();
+                menuSamples.PlayCloseSample();
 
             wasOpened = false;
         }
diff --git a/osu.Game/Graphics/UserInterface/OsuContextMenuSamples.cs b/osu.Game/Graphics/UserInterface/OsuContextMenuSamples.cs
diff --git a/osu.Game/Graphics/UserInterface/OsuMenu.cs b/osu.Game/Graphics/UserInterface/OsuMenu.cs
@@ -4,8 +4,6 @@
 #nullable disable
 
 using osu.Framework.Allocation;
-using osu.Framework.Audio;
-using osu.Framework.Audio.Sample;
 using osu.Framework.Extensions.Color4Extensions;
 using osu.Framework.Graphics;
 using osu.Framework.Graphics.Containers;
@@ -20,26 +18,21 @@ namespace osu.Game.Graphics.UserInterface
 {
     public partial class OsuMenu : Menu
     {
-        private Sample sampleOpen;
-        private Sample sampleClose;
-
         // todo: this shouldn't be required after https://github.com/ppy/osu-framework/issues/4519 is fixed.
         private bool wasOpened;
 
+        [Resolved]
+        private OsuMenuSamples menuSamples { get; set; } = null!;
+
         public OsuMenu(Direction direction, bool topLevelMenu = false)
             : base(direction, topLevelMenu)
         {
             BackgroundColour = Color4.Black.Opacity(0.5f);
 
             MaskingContainer.CornerRadius = 4;
             ItemsContainer.Padding = new MarginPadding(5);
-        }
 
-        [BackgroundDependencyLoader]
-        private void load(AudioManager audio)
-        {
-            sampleOpen = audio.Samples.Get(@"UI/dropdown-open");
-            sampleClose = audio.Samples.Get(@"UI/dropdown-close");
+            OnSubmenuOpen += _ => { menuSamples?.PlaySubOpenSample(); };
         }
 
         protected override void Update()
@@ -64,7 +57,7 @@ protected override void Update()
         protected override void AnimateOpen()
         {
             if (!TopLevelMenu && !wasOpened)
-                sampleOpen?.Play();
+                menuSamples?.PlayOpenSample();
 
             this.FadeIn(300, Easing.OutQuint);
             wasOpened = true;
@@ -73,7 +66,7 @@ protected override void AnimateOpen()
         protected override void AnimateClose()
         {
             if (!TopLevelMenu && wasOpened)
-                sampleClose?.Play();
+                menuSamples?.PlayCloseSample();
 
             this.FadeOut(300, Easing.OutQuint);
             wasOpened = false;
diff --git a/osu.Game/Graphics/UserInterface/OsuMenuSamples.cs b/osu.Game/Graphics/UserInterface/OsuMenuSamples.cs
@@ -0,0 +1,70 @@
+// 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.
+
+#nullable disable
+
+using osu.Framework.Allocation;
+using osu.Framework.Audio;
+using osu.Framework.Audio.Sample;
+using osu.Framework.Graphics;
+
+namespace osu.Game.Graphics.UserInterface
+{
+    public partial class OsuMenuSamples : Component
+    {
+        private Sample sampleClick;
+        private Sample sampleOpen;
+        private Sample sampleSubOpen;
+        private Sample sampleClose;
+
+        private bool triggerOpen;
+        private bool triggerSubOpen;
+        private bool triggerClose;
+
+        [BackgroundDependencyLoader]
+        private void load(AudioManager audio)
+        {
+            sampleClick = audio.Samples.Get(@"UI/menu-open-select");
+            sampleOpen = audio.Samples.Get(@"UI/menu-open");
+            sampleSubOpen = audio.Samples.Get(@"UI/menu-sub-open");
+            sampleClose = audio.Samples.Get(@"UI/menu-close");
+        }
+
+        public void PlayClickSample()
+        {
+            Scheduler.AddOnce(playClickSample);
+        }
+
+        public void PlayOpenSample()
+        {
+            triggerOpen = true;
+            Scheduler.AddOnce(resolvePlayback);
+        }
+
+        public void PlaySubOpenSample()
+        {
+            triggerSubOpen = true;
+            Scheduler.AddOnce(resolvePlayback);
+        }
+
+        public void PlayCloseSample()
+        {
+            triggerClose = true;
+            Scheduler.AddOnce(resolvePlayback);
+        }
+
+        private void playClickSample() => sampleClick.Play();
+
+        private void resolvePlayback()
+        {
+            if (triggerSubOpen)
+                sampleSubOpen?.Play();
+            else if (triggerOpen)
+                sampleOpen?.Play();
+            else if (triggerClose)
+                sampleClose?.Play();
+
+            triggerOpen = triggerSubOpen = triggerClose = false;
+        }
+    }
+}
diff --git a/osu.Game/OsuGameBase.cs b/osu.Game/OsuGameBase.cs
@@ -41,6 +41,7 @@
 using osu.Game.Extensions;
 using osu.Game.Graphics;
 using osu.Game.Graphics.Cursor;
+using osu.Game.Graphics.UserInterface;
 using osu.Game.Input;
 using osu.Game.Input.Bindings;
 using osu.Game.IO;
@@ -383,6 +384,10 @@ private void load(ReadableKeyCombinationProvider keyCombinationProvider, Framewo
 
             GlobalActionContainer globalBindings;
 
+            OsuMenuSamples menuSamples;
+            dependencies.Cache(menuSamples = new OsuMenuSamples());
+            base.Content.Add(menuSamples);
+
             base.Content.Add(SafeAreaContainer = new SafeAreaContainer
             {
                 SafeAreaOverrideEdges = SafeAreaOverrideEdges,
diff --git a/osu.Game/Screens/Edit/Components/Menus/EditorMenuBar.cs b/osu.Game/Screens/Edit/Components/Menus/EditorMenuBar.cs
@@ -99,7 +99,7 @@ private void load(OverlayColourProvider colourProvider)
                 ForegroundColourHover = colourProvider.Content1;
                 BackgroundColourHover = colourProvider.Background1;
 
-                AddInternal(hoverClickSounds = new HoverClickSounds());
+                AddInternal(hoverClickSounds = new HoverClickSounds(HoverSampleSet.MenuOpen));
             }
 
             protected override void LoadComplete()
diff --git a/osu.Game/osu.Game.csproj b/osu.Game/osu.Game.csproj
@@ -35,8 +35,8 @@
       <IncludeAssets>runtime; build; native; contentfiles; analyzers; buildtransitive</IncludeAssets>
     </PackageReference>
     <PackageReference Include="Realm" Version="11.5.0" />
-    <PackageReference Include="ppy.osu.Framework" Version="2024.1128.0" />
-    <PackageReference Include="ppy.osu.Game.Resources" Version="2024.1106.0" />
+    <PackageReference Include="ppy.osu.Framework" Version="2024.1205.0" />
+    <PackageReference Include="ppy.osu.Game.Resources" Version="2024.1202.0" />
     <PackageReference Include="Sentry" Version="4.13.0" />
     <!-- Held back due to 0.34.0 failing AOT compilation on ZstdSharp.dll dependency. -->
     <PackageReference Include="SharpCompress" Version="0.38.0" />
diff --git a/osu.iOS.props b/osu.iOS.props
@@ -17,6 +17,6 @@
     <MtouchInterpreter>-all</MtouchInterpreter>
   </PropertyGroup>
   <ItemGroup>
-    <PackageReference Include="ppy.osu.Framework.iOS" Version="2024.1128.0" />
+    <PackageReference Include="ppy.osu.Framework.iOS" Version="2024.1205.0" />
   </ItemGroup>
 </Project>

Original file line number	Diff line number	Diff line change
`@@ -101,7 +101,16 @@ private static MenuItem[] makeMenu()`
`101`	`101`	`}`
`102`	`102`	`}`
`103`	`103`	`}`
`104`		`- }`
	`104`	`+ },`
	`105`	`+ }`
	`106`	`+ },`
	`107`	`+ new OsuMenuItem(@"Another nested option")`
	`108`	`+ {`
	`109`	`+ Items = new MenuItem[]`
	`110`	`+ {`
	`111`	`+ new OsuMenuItem(@"Sub-One"),`
	`112`	`+ new OsuMenuItem(@"Sub-Two"),`
	`113`	`+ new OsuMenuItem(@"Sub-Three"),`
`105`	`114`	`}`
`106`	`115`	`},`
`107`	`116`	`new OsuMenuItem(@"Choose me please"),`
Original file line number	Diff line number	Diff line change
`@@ -23,6 +23,9 @@ public enum HoverSampleSet`
`23`	`23`	`DialogCancel,`
`24`	`24`
`25`	`25`	`[Description("dialog-ok")]`
`26`		`- DialogOk`
	`26`	`+ DialogOk,`
	`27`	`+`
	`28`	`+ [Description("menu-open")]`
	`29`	`+ MenuOpen,`
`27`	`30`	`}`
`28`	`31`	`}`
Original file line number	Diff line number	Diff line change
`@@ -99,7 +99,7 @@ private void load(OverlayColourProvider colourProvider)`
`99`	`99`	`ForegroundColourHover = colourProvider.Content1;`
`100`	`100`	`BackgroundColourHover = colourProvider.Background1;`
`101`	`101`
`102`		`- AddInternal(hoverClickSounds = new HoverClickSounds());`
	`102`	`+ AddInternal(hoverClickSounds = new HoverClickSounds(HoverSampleSet.MenuOpen));`
`103`	`103`	`}`
`104`	`104`
`105`	`105`	`protected override void LoadComplete()`