From 2856213c803bd6854a8d2d7e9d2491b206c1a9d6 Mon Sep 17 00:00:00 2001
From: theashtronaut <112137107+theashtronaut@users.noreply.github.com>
Date: Fri, 4 Nov 2022 00:15:37 +0000
Subject: [PATCH] Add lobby music volume slider (#12153)

---
 Content.Client/Audio/BackgroundAudioSystem.cs | 19 +++++++++++++----
 Content.Client/Options/UI/Tabs/AudioTab.xaml  | 21 +++++++++++++++----
 .../Options/UI/Tabs/AudioTab.xaml.cs          | 16 +++++++++++++-
 Content.Shared/CCVar/CCVars.cs                |  6 ++++++
 .../en-US/escape-menu/ui/options-menu.ftl     |  1 +
 5 files changed, 54 insertions(+), 9 deletions(-)

diff --git a/Content.Client/Audio/BackgroundAudioSystem.cs b/Content.Client/Audio/BackgroundAudioSystem.cs
index 03b69c336a..6508767a80 100644
--- a/Content.Client/Audio/BackgroundAudioSystem.cs
+++ b/Content.Client/Audio/BackgroundAudioSystem.cs
@@ -31,7 +31,7 @@ public sealed class BackgroundAudioSystem : EntitySystem
     [Dependency] private readonly IRobustRandom _robustRandom = default!;
     [Dependency] private readonly IStateManager _stateManager = default!;
     [Dependency] private readonly IGameTiming _timing = default!;
-    
+
     private readonly AudioParams _ambientParams = new(-10f, 1, "Master", 0, 0, 0, true, 0f);
     private readonly AudioParams _lobbyParams = new(-5f, 1, "Master", 0, 0, 0, true, 0f);
 
@@ -70,6 +70,7 @@ public sealed class BackgroundAudioSystem : EntitySystem
 
         _configManager.OnValueChanged(CCVars.AmbienceVolume, AmbienceCVarChanged);
         _configManager.OnValueChanged(CCVars.LobbyMusicEnabled, LobbyMusicCVarChanged);
+        _configManager.OnValueChanged(CCVars.LobbyMusicVolume, LobbyMusicVolumeCVarChanged);
         _configManager.OnValueChanged(CCVars.StationAmbienceEnabled, StationAmbienceCVarChanged);
         _configManager.OnValueChanged(CCVars.SpaceAmbienceEnabled, SpaceAmbienceCVarChanged);
 
@@ -103,6 +104,7 @@ public sealed class BackgroundAudioSystem : EntitySystem
 
         _configManager.UnsubValueChanged(CCVars.AmbienceVolume, AmbienceCVarChanged);
         _configManager.UnsubValueChanged(CCVars.LobbyMusicEnabled, LobbyMusicCVarChanged);
+        _configManager.UnsubValueChanged(CCVars.LobbyMusicVolume, LobbyMusicVolumeCVarChanged);
         _configManager.UnsubValueChanged(CCVars.StationAmbienceEnabled, StationAmbienceCVarChanged);
         _configManager.UnsubValueChanged(CCVars.SpaceAmbienceEnabled, SpaceAmbienceCVarChanged);
 
@@ -139,7 +141,7 @@ public sealed class BackgroundAudioSystem : EntitySystem
     {
         if (_currentCollection == newAmbience)
             return;
-        
+
         _timerCancelTokenSource.Cancel();
         _currentCollection = newAmbience;
         _timerCancelTokenSource = new CancellationTokenSource();
@@ -248,6 +250,14 @@ public sealed class BackgroundAudioSystem : EntitySystem
         }
     }
 
+    private void LobbyMusicVolumeCVarChanged(float volume)
+    {
+        if (_stateManager.CurrentState is LobbyState)
+        {
+            RestartLobbyMusic();
+        }
+    }
+
     private void LobbyMusicCVarChanged(bool musicEnabled)
     {
         if (!musicEnabled)
@@ -294,7 +304,8 @@ public sealed class BackgroundAudioSystem : EntitySystem
             return;
         }
 
-        _lobbyStream = _audio.PlayGlobal(file, Filter.Local(), _lobbyParams);
+        _lobbyStream = _audio.PlayGlobal(file, Filter.Local(),
+            _lobbyParams.WithVolume(_lobbyParams.Volume + _configManager.GetCVar(CCVars.LobbyMusicVolume)));
     }
 
     private void EndLobbyMusic()
@@ -302,4 +313,4 @@ public sealed class BackgroundAudioSystem : EntitySystem
         _lobbyStream?.Stop();
         _lobbyStream = null;
     }
-}
\ No newline at end of file
+}
diff --git a/Content.Client/Options/UI/Tabs/AudioTab.xaml b/Content.Client/Options/UI/Tabs/AudioTab.xaml
index d6da27f63e..ccf4d16ede 100644
--- a/Content.Client/Options/UI/Tabs/AudioTab.xaml
+++ b/Content.Client/Options/UI/Tabs/AudioTab.xaml
@@ -9,7 +9,7 @@
                    StyleClasses="LabelKeyText"/>
             <BoxContainer Orientation="Vertical" Margin="0 3 0 0">
                 <BoxContainer Orientation="Horizontal" Margin="5 0 0 0">
-                    <Label Text="{Loc 'ui-options-master-volume'}" />
+                    <Label Text="{Loc 'ui-options-master-volume'}" HorizontalExpand="True" />
                     <Control MinSize="8 0" />
                     <Slider Name="MasterVolumeSlider"
                             MinValue="0"
@@ -23,7 +23,7 @@
                 </BoxContainer>
                 <Control MinSize="0 8" />
                 <BoxContainer Orientation="Horizontal" Margin="5 0 0 0">
-                    <Label Text="{Loc 'ui-options-midi-volume'}" />
+                    <Label Text="{Loc 'ui-options-midi-volume'}" HorizontalExpand="True" />
                     <Control MinSize="8 0" />
                     <Slider Name="MidiVolumeSlider"
                             MinValue="0"
@@ -36,7 +36,7 @@
                     <Control MinSize="4 0"/>
                 </BoxContainer>
                 <BoxContainer Orientation="Horizontal" Margin="5 0 0 0">
-                    <Label Text="{Loc 'ui-options-ambience-volume'}" />
+                    <Label Text="{Loc 'ui-options-ambience-volume'}" HorizontalExpand="True" />
                     <Control MinSize="8 0" />
                     <Slider Name="AmbienceVolumeSlider"
                             MinValue="0"
@@ -49,7 +49,20 @@
                     <Control MinSize="4 0"/>
                 </BoxContainer>
                 <BoxContainer Orientation="Horizontal" Margin="5 0 0 0">
-                    <Label Text="{Loc 'ui-options-ambience-max-sounds'}" />
+                    <Label Text="{Loc 'ui-options-lobby-volume'}" HorizontalExpand="True" />
+                    <Control MinSize="8 0" />
+                    <Slider Name="LobbyVolumeSlider"
+                            MinValue="0"
+                            MaxValue="200"
+                            HorizontalExpand="True"
+                            MinSize="80 0"
+                            Rounded="True" />
+                    <Control MinSize="8 0" />
+                    <Label Name="LobbyVolumeLabel" MinSize="48 0" Align="Right" />
+                    <Control MinSize="4 0"/>
+                </BoxContainer>
+                <BoxContainer Orientation="Horizontal" Margin="5 0 0 0">
+                    <Label Text="{Loc 'ui-options-ambience-max-sounds'}" HorizontalExpand="True" />
                     <Control MinSize="8 0" />
                     <Slider Name="AmbienceSoundsSlider"
                             MinValue="0"
diff --git a/Content.Client/Options/UI/Tabs/AudioTab.xaml.cs b/Content.Client/Options/UI/Tabs/AudioTab.xaml.cs
index 6bc2113915..1729bfc706 100644
--- a/Content.Client/Options/UI/Tabs/AudioTab.xaml.cs
+++ b/Content.Client/Options/UI/Tabs/AudioTab.xaml.cs
@@ -34,6 +34,7 @@ namespace Content.Client.Options.UI.Tabs
             MidiVolumeSlider.OnValueChanged += OnMidiVolumeSliderChanged;
             AmbienceVolumeSlider.OnValueChanged += OnAmbienceVolumeSliderChanged;
             AmbienceSoundsSlider.OnValueChanged += OnAmbienceSoundsSliderChanged;
+            LobbyVolumeSlider.OnValueChanged += OnLobbyVolumeSliderChanged;
             LobbyMusicCheckBox.OnToggled += OnLobbyMusicCheckToggled;
             RestartSoundsCheckBox.OnToggled += OnRestartSoundsCheckToggled;
             EventMusicCheckBox.OnToggled += OnEventMusicCheckToggled;
@@ -54,9 +55,15 @@ namespace Content.Client.Options.UI.Tabs
             MasterVolumeSlider.OnValueChanged -= OnMasterVolumeSliderChanged;
             MidiVolumeSlider.OnValueChanged -= OnMidiVolumeSliderChanged;
             AmbienceVolumeSlider.OnValueChanged -= OnAmbienceVolumeSliderChanged;
+            LobbyVolumeSlider.OnValueChanged -= OnLobbyVolumeSliderChanged;
             base.Dispose(disposing);
         }
 
+        private void OnLobbyVolumeSliderChanged(Range obj)
+        {
+            UpdateChanges();
+        }
+
         private void OnAmbienceVolumeSliderChanged(Range obj)
         {
             UpdateChanges();
@@ -111,6 +118,7 @@ namespace Content.Client.Options.UI.Tabs
             _cfg.SetCVar(CVars.AudioMasterVolume, MasterVolumeSlider.Value / 100);
             _cfg.SetCVar(CVars.MidiVolume, LV100ToDB(MidiVolumeSlider.Value));
             _cfg.SetCVar(CCVars.AmbienceVolume, LV100ToDB(AmbienceVolumeSlider.Value));
+            _cfg.SetCVar(CCVars.LobbyMusicVolume, LV100ToDB(LobbyVolumeSlider.Value));
             _cfg.SetCVar(CCVars.MaxAmbientSources, (int)AmbienceSoundsSlider.Value);
             _cfg.SetCVar(CCVars.LobbyMusicEnabled, LobbyMusicCheckBox.Pressed);
             _cfg.SetCVar(CCVars.RestartSoundsEnabled, RestartSoundsCheckBox.Pressed);
@@ -132,6 +140,7 @@ namespace Content.Client.Options.UI.Tabs
             MasterVolumeSlider.Value = _cfg.GetCVar(CVars.AudioMasterVolume) * 100;
             MidiVolumeSlider.Value = DBToLV100(_cfg.GetCVar(CVars.MidiVolume));
             AmbienceVolumeSlider.Value = DBToLV100(_cfg.GetCVar(CCVars.AmbienceVolume));
+            LobbyVolumeSlider.Value = DBToLV100(_cfg.GetCVar(CCVars.LobbyMusicVolume));
             AmbienceSoundsSlider.Value = _cfg.GetCVar(CCVars.MaxAmbientSources);
             LobbyMusicCheckBox.Pressed = _cfg.GetCVar(CCVars.LobbyMusicEnabled);
             RestartSoundsCheckBox.Pressed = _cfg.GetCVar(CCVars.RestartSoundsEnabled);
@@ -163,6 +172,8 @@ namespace Content.Client.Options.UI.Tabs
                 Math.Abs(MidiVolumeSlider.Value - DBToLV100(_cfg.GetCVar(CVars.MidiVolume))) < 0.01f;
             var isAmbientVolumeSame =
                 Math.Abs(AmbienceVolumeSlider.Value - DBToLV100(_cfg.GetCVar(CCVars.AmbienceVolume))) < 0.01f;
+            var isLobbyVolumeSame =
+                Math.Abs(LobbyVolumeSlider.Value - DBToLV100(_cfg.GetCVar(CCVars.LobbyMusicVolume))) < 0.01f;
             var isAmbientSoundsSame = (int)AmbienceSoundsSlider.Value == _cfg.GetCVar(CCVars.MaxAmbientSources);
             var isLobbySame = LobbyMusicCheckBox.Pressed == _cfg.GetCVar(CCVars.LobbyMusicEnabled);
             var isRestartSoundsSame = RestartSoundsCheckBox.Pressed == _cfg.GetCVar(CCVars.RestartSoundsEnabled);
@@ -170,7 +181,8 @@ namespace Content.Client.Options.UI.Tabs
             var isAdminSoundsSame = AdminSoundsCheckBox.Pressed == _cfg.GetCVar(CCVars.AdminSoundsEnabled);
             var isStationAmbienceSame = StationAmbienceCheckBox.Pressed == _cfg.GetCVar(CCVars.StationAmbienceEnabled);
             var isSpaceAmbienceSame = SpaceAmbienceCheckBox.Pressed == _cfg.GetCVar(CCVars.SpaceAmbienceEnabled);
-            var isEverythingSame = isMasterVolumeSame && isMidiVolumeSame && isAmbientVolumeSame && isAmbientSoundsSame && isLobbySame && isRestartSoundsSame && isEventSame && isAdminSoundsSame && isStationAmbienceSame && isSpaceAmbienceSame;
+            var isEverythingSame = isMasterVolumeSame && isMidiVolumeSame && isAmbientVolumeSame && isAmbientSoundsSame && isLobbySame && isRestartSoundsSame && isEventSame
+                                   && isAdminSoundsSame && isStationAmbienceSame && isSpaceAmbienceSame && isLobbyVolumeSame;
             ApplyButton.Disabled = isEverythingSame;
             ResetButton.Disabled = isEverythingSame;
             MasterVolumeLabel.Text =
@@ -179,6 +191,8 @@ namespace Content.Client.Options.UI.Tabs
                 Loc.GetString("ui-options-volume-percent", ("volume", MidiVolumeSlider.Value / 100));
             AmbienceVolumeLabel.Text =
                 Loc.GetString("ui-options-volume-percent", ("volume", AmbienceVolumeSlider.Value / 100));
+            LobbyVolumeLabel.Text =
+                Loc.GetString("ui-options-volume-percent", ("volume", LobbyVolumeSlider.Value / 100));
             AmbienceSoundsLabel.Text = ((int)AmbienceSoundsSlider.Value).ToString();
         }
     }
diff --git a/Content.Shared/CCVar/CCVars.cs b/Content.Shared/CCVar/CCVars.cs
index 8c01c04d34..5d23745f17 100644
--- a/Content.Shared/CCVar/CCVars.cs
+++ b/Content.Shared/CCVar/CCVars.cs
@@ -74,6 +74,12 @@ namespace Content.Shared.CCVar
         public static readonly CVarDef<float> AmbienceVolume =
             CVarDef.Create("ambience.volume", 0.0f, CVar.ARCHIVE | CVar.CLIENTONLY);
 
+        /// <summary>
+        /// Lobby / round end music volume.
+        /// </summary>
+        public static readonly CVarDef<float> LobbyMusicVolume =
+            CVarDef.Create("ambience.lobby_music_volume", 0.0f, CVar.ARCHIVE | CVar.CLIENTONLY);
+
         /// <summary>
         /// Whether to play the station ambience (humming) sound
         /// </summary>
diff --git a/Resources/Locale/en-US/escape-menu/ui/options-menu.ftl b/Resources/Locale/en-US/escape-menu/ui/options-menu.ftl
index 954983fb56..686799a4ef 100644
--- a/Resources/Locale/en-US/escape-menu/ui/options-menu.ftl
+++ b/Resources/Locale/en-US/escape-menu/ui/options-menu.ftl
@@ -15,6 +15,7 @@ ui-options-default = Default
 ui-options-master-volume = Master Volume:
 ui-options-midi-volume = MIDI (Instrument) Volume:
 ui-options-ambience-volume = Ambience volume:
+ui-options-lobby-volume = Lobby & Round-end volume:
 ui-options-ambience-max-sounds = Ambience simultaneous sounds:
 ui-options-lobby-music = Lobby & Round-end Music
 ui-options-restart-sounds = Round Restart Sounds