Adds lobby music (#3620)
* Adds lobby music * Add UI toggle for lobby music * Pick the song serverside so everyone gets the same song * Add more songs * Fixes * Catch-all end lobby music * Rename it * Catchall ambience cvar change * Wait until we receive the lobby song to start playing one * Fix toggling ready status resetting the song * Comment * Expend the last of my sanity fixing latejoin lobby music * Update Content.Client/GameObjects/EntitySystems/BackgroundAudioSystem.cs Co-authored-by: metalgearsloth <31366439+metalgearsloth@users.noreply.github.com> * Update Content.Client/GameObjects/EntitySystems/BackgroundAudioSystem.cs Co-authored-by: metalgearsloth <31366439+metalgearsloth@users.noreply.github.com> * Update Content.Client/GameObjects/EntitySystems/BackgroundAudioSystem.cs Co-authored-by: metalgearsloth <31366439+metalgearsloth@users.noreply.github.com> * Move the var Co-authored-by: ike709 <sparebytes@protonmail.com> Co-authored-by: metalgearsloth <31366439+metalgearsloth@users.noreply.github.com>
This commit is contained in:
@@ -1,95 +0,0 @@
|
||||
#nullable enable
|
||||
using Content.Shared.Audio;
|
||||
using JetBrains.Annotations;
|
||||
using Robust.Client.GameObjects;
|
||||
using Content.Shared;
|
||||
using Robust.Shared.Audio;
|
||||
using Robust.Shared.Configuration;
|
||||
using Robust.Shared.GameObjects;
|
||||
using Robust.Shared.IoC;
|
||||
using Robust.Shared.Prototypes;
|
||||
using Robust.Shared.Random;
|
||||
using Robust.Client;
|
||||
using Robust.Client.State;
|
||||
using Content.Client.State;
|
||||
|
||||
namespace Content.Client.GameObjects.EntitySystems
|
||||
{
|
||||
[UsedImplicitly]
|
||||
public class AmbienceSystem : EntitySystem
|
||||
{
|
||||
[Dependency] private readonly IPrototypeManager _prototypeManager = default!;
|
||||
[Dependency] private readonly IRobustRandom _robustRandom = default!;
|
||||
[Dependency] private readonly IConfigurationManager _configManager = default!;
|
||||
[Dependency] private readonly IStateManager _stateManager = default!;
|
||||
|
||||
private AudioSystem _audioSystem = default!;
|
||||
|
||||
private SoundCollectionPrototype _ambientCollection = default!;
|
||||
|
||||
private AudioParams _ambientParams = new(-10f, 1, "Master", 0, 0, AudioMixTarget.Stereo, true, 0f);
|
||||
|
||||
private IPlayingAudioStream? _ambientStream;
|
||||
|
||||
public override void Initialize()
|
||||
{
|
||||
base.Initialize();
|
||||
|
||||
_audioSystem = EntitySystemManager.GetEntitySystem<AudioSystem>();
|
||||
_ambientCollection = _prototypeManager.Index<SoundCollectionPrototype>("AmbienceBase");
|
||||
|
||||
_configManager.OnValueChanged(CCVars.AmbienceBasicEnabled, AmbienceCVarChanged);
|
||||
|
||||
_stateManager.OnStateChanged += StateManagerOnStateChanged;
|
||||
}
|
||||
|
||||
public override void Shutdown()
|
||||
{
|
||||
base.Shutdown();
|
||||
|
||||
_stateManager.OnStateChanged -= StateManagerOnStateChanged;
|
||||
}
|
||||
|
||||
private void StateManagerOnStateChanged(StateChangedEventArgs args)
|
||||
{
|
||||
if (args.NewState is not GameScreen)
|
||||
{
|
||||
EndAmbience();
|
||||
}
|
||||
else if (_configManager.GetCVar(CCVars.AmbienceBasicEnabled))
|
||||
{
|
||||
StartAmbience();
|
||||
}
|
||||
}
|
||||
|
||||
private void AmbienceCVarChanged(bool ambienceEnabled)
|
||||
{
|
||||
if (!ambienceEnabled)
|
||||
{
|
||||
EndAmbience();
|
||||
}
|
||||
else if (_stateManager.CurrentState is GameScreen)
|
||||
{
|
||||
StartAmbience();
|
||||
}
|
||||
}
|
||||
|
||||
private void StartAmbience()
|
||||
{
|
||||
EndAmbience();
|
||||
var file = _robustRandom.Pick(_ambientCollection.PickFiles);
|
||||
_ambientStream = _audioSystem.Play(file, _ambientParams);
|
||||
}
|
||||
|
||||
private void EndAmbience()
|
||||
{
|
||||
if (_ambientStream == null)
|
||||
{
|
||||
return;
|
||||
}
|
||||
_ambientStream.Stop();
|
||||
_ambientStream = null;
|
||||
}
|
||||
}
|
||||
}
|
||||
|
||||
@@ -0,0 +1,186 @@
|
||||
#nullable enable
|
||||
using Content.Client.Interfaces;
|
||||
using Content.Shared.Audio;
|
||||
using JetBrains.Annotations;
|
||||
using Robust.Client.GameObjects;
|
||||
using Content.Shared;
|
||||
using Robust.Shared.Audio;
|
||||
using Robust.Shared.Configuration;
|
||||
using Robust.Shared.GameObjects;
|
||||
using Robust.Shared.IoC;
|
||||
using Robust.Shared.Prototypes;
|
||||
using Robust.Shared.Random;
|
||||
using Robust.Client;
|
||||
using Robust.Client.State;
|
||||
using Content.Client.State;
|
||||
|
||||
namespace Content.Client.GameObjects.EntitySystems
|
||||
{
|
||||
[UsedImplicitly]
|
||||
public class BackgroundAudioSystem : EntitySystem
|
||||
{
|
||||
[Dependency] private readonly IPrototypeManager _prototypeManager = default!;
|
||||
[Dependency] private readonly IRobustRandom _robustRandom = default!;
|
||||
[Dependency] private readonly IConfigurationManager _configManager = default!;
|
||||
[Dependency] private readonly IStateManager _stateManager = default!;
|
||||
[Dependency] private readonly IBaseClient _client = default!;
|
||||
[Dependency] private readonly IClientGameTicker _clientGameTicker = default!;
|
||||
|
||||
private AudioSystem _audioSystem = default!;
|
||||
|
||||
private SoundCollectionPrototype _ambientCollection = default!;
|
||||
|
||||
private AudioParams _ambientParams = new(-10f, 1, "Master", 0, 0, AudioMixTarget.Stereo, true, 0f);
|
||||
private AudioParams _lobbyParams = new(5f, 1, "Master", 0, 0, AudioMixTarget.Stereo, true, 0f);
|
||||
|
||||
private IPlayingAudioStream? _ambientStream;
|
||||
private IPlayingAudioStream? _lobbyStream;
|
||||
|
||||
public override void Initialize()
|
||||
{
|
||||
base.Initialize();
|
||||
|
||||
_audioSystem = Get<AudioSystem>();
|
||||
|
||||
_ambientCollection = _prototypeManager.Index<SoundCollectionPrototype>("AmbienceBase");
|
||||
|
||||
_configManager.OnValueChanged(CCVars.AmbienceBasicEnabled, AmbienceCVarChanged);
|
||||
_configManager.OnValueChanged(CCVars.LobbyMusicEnabled, LobbyMusicCVarChanged);
|
||||
|
||||
_stateManager.OnStateChanged += StateManagerOnStateChanged;
|
||||
|
||||
_client.PlayerJoinedServer += OnJoin;
|
||||
_client.PlayerLeaveServer += OnLeave;
|
||||
|
||||
_clientGameTicker.LobbyStatusUpdated += LobbySongReceived;
|
||||
}
|
||||
|
||||
public override void Shutdown()
|
||||
{
|
||||
base.Shutdown();
|
||||
|
||||
_stateManager.OnStateChanged -= StateManagerOnStateChanged;
|
||||
|
||||
_client.PlayerJoinedServer -= OnJoin;
|
||||
_client.PlayerLeaveServer -= OnLeave;
|
||||
|
||||
_clientGameTicker.LobbyStatusUpdated -= LobbySongReceived;
|
||||
|
||||
EndAmbience();
|
||||
EndLobbyMusic();
|
||||
}
|
||||
|
||||
private void StateManagerOnStateChanged(StateChangedEventArgs args)
|
||||
{
|
||||
EndAmbience();
|
||||
EndLobbyMusic();
|
||||
if (args.NewState is LobbyState && _configManager.GetCVar(CCVars.LobbyMusicEnabled))
|
||||
{
|
||||
StartLobbyMusic();
|
||||
}
|
||||
else if (args.NewState is GameScreen && _configManager.GetCVar(CCVars.AmbienceBasicEnabled))
|
||||
{
|
||||
StartAmbience();
|
||||
}
|
||||
}
|
||||
|
||||
private void OnJoin(object? sender, PlayerEventArgs args)
|
||||
{
|
||||
if (_stateManager.CurrentState is LobbyState)
|
||||
{
|
||||
EndAmbience();
|
||||
if (_configManager.GetCVar(CCVars.LobbyMusicEnabled))
|
||||
{
|
||||
StartLobbyMusic();
|
||||
}
|
||||
}
|
||||
else
|
||||
{
|
||||
EndLobbyMusic();
|
||||
if (_configManager.GetCVar(CCVars.AmbienceBasicEnabled))
|
||||
{
|
||||
StartAmbience();
|
||||
}
|
||||
}
|
||||
}
|
||||
|
||||
private void OnLeave(object? sender, PlayerEventArgs args)
|
||||
{
|
||||
EndAmbience();
|
||||
EndLobbyMusic();
|
||||
}
|
||||
|
||||
private void AmbienceCVarChanged(bool ambienceEnabled)
|
||||
{
|
||||
if (!ambienceEnabled)
|
||||
{
|
||||
EndAmbience();
|
||||
}
|
||||
else if (_stateManager.CurrentState is GameScreen)
|
||||
{
|
||||
StartAmbience();
|
||||
}
|
||||
else
|
||||
{
|
||||
EndAmbience();
|
||||
}
|
||||
}
|
||||
|
||||
private void StartAmbience()
|
||||
{
|
||||
EndAmbience();
|
||||
var file = _robustRandom.Pick(_ambientCollection.PickFiles);
|
||||
_ambientStream = _audioSystem.Play(file, _ambientParams);
|
||||
}
|
||||
|
||||
private void EndAmbience()
|
||||
{
|
||||
_ambientStream?.Stop();
|
||||
_ambientStream = null;
|
||||
}
|
||||
|
||||
private void LobbyMusicCVarChanged(bool musicEnabled)
|
||||
{
|
||||
if (!musicEnabled)
|
||||
{
|
||||
EndLobbyMusic();
|
||||
}
|
||||
else if (_stateManager.CurrentState is LobbyState)
|
||||
{
|
||||
StartLobbyMusic();
|
||||
}
|
||||
else
|
||||
{
|
||||
EndLobbyMusic();
|
||||
}
|
||||
}
|
||||
|
||||
private void LobbySongReceived()
|
||||
{
|
||||
if (_lobbyStream != null) //Toggling Ready status fires this method. This check ensures we only start the lobby music if it's not playing.
|
||||
{
|
||||
return;
|
||||
}
|
||||
if (_stateManager.CurrentState is LobbyState && _configManager.GetCVar(CCVars.LobbyMusicEnabled))
|
||||
{
|
||||
StartLobbyMusic();
|
||||
}
|
||||
}
|
||||
private void StartLobbyMusic()
|
||||
{
|
||||
EndLobbyMusic();
|
||||
var file = _clientGameTicker.LobbySong;
|
||||
if (file == null) // We have not received the lobby song yet.
|
||||
{
|
||||
return;
|
||||
}
|
||||
_lobbyStream = _audioSystem.Play(file, _lobbyParams);
|
||||
}
|
||||
|
||||
private void EndLobbyMusic()
|
||||
{
|
||||
_lobbyStream?.Stop();
|
||||
_lobbyStream = null;
|
||||
}
|
||||
}
|
||||
}
|
||||
@@ -24,6 +24,7 @@ namespace Content.Client.GameTicking
|
||||
|
||||
[ViewVariables] public bool AreWeReady { get; private set; }
|
||||
[ViewVariables] public bool IsGameStarted { get; private set; }
|
||||
[ViewVariables] public string? LobbySong { get; private set; }
|
||||
[ViewVariables] public bool DisallowedLateJoin { get; private set; }
|
||||
[ViewVariables] public string? ServerInfoBlob { get; private set; }
|
||||
[ViewVariables] public TimeSpan StartTime { get; private set; }
|
||||
@@ -82,6 +83,7 @@ namespace Content.Client.GameTicking
|
||||
StartTime = message.StartTime;
|
||||
IsGameStarted = message.IsRoundStarted;
|
||||
AreWeReady = message.YouAreReady;
|
||||
LobbySong = message.LobbySong;
|
||||
Paused = message.Paused;
|
||||
if (IsGameStarted)
|
||||
Status.Clear();
|
||||
|
||||
@@ -10,6 +10,7 @@ namespace Content.Client.Interfaces
|
||||
bool IsGameStarted { get; }
|
||||
string? ServerInfoBlob { get; }
|
||||
bool AreWeReady { get; }
|
||||
string? LobbySong { get; }
|
||||
bool DisallowedLateJoin { get; }
|
||||
TimeSpan StartTime { get; }
|
||||
bool Paused { get; }
|
||||
|
||||
@@ -21,6 +21,7 @@ namespace Content.Client.UserInterface
|
||||
private readonly Label MasterVolumeLabel;
|
||||
private readonly Slider MasterVolumeSlider;
|
||||
private readonly CheckBox AmbienceCheckBox;
|
||||
private readonly CheckBox LobbyMusicCheckBox;
|
||||
private readonly Button ResetButton;
|
||||
|
||||
public AudioControl(IConfigurationManager cfg, IClydeAudio clydeAudio)
|
||||
@@ -70,6 +71,10 @@ namespace Content.Client.UserInterface
|
||||
contents.AddChild(AmbienceCheckBox);
|
||||
AmbienceCheckBox.Pressed = _cfg.GetCVar(CCVars.AmbienceBasicEnabled);
|
||||
|
||||
LobbyMusicCheckBox = new CheckBox {Text = Loc.GetString("ui-options-lobby-music")};
|
||||
contents.AddChild(LobbyMusicCheckBox);
|
||||
LobbyMusicCheckBox.Pressed = _cfg.GetCVar(CCVars.LobbyMusicEnabled);
|
||||
|
||||
ApplyButton = new Button
|
||||
{
|
||||
Text = Loc.GetString("ui-options-apply"), TextAlign = Label.AlignMode.Center,
|
||||
@@ -118,6 +123,7 @@ namespace Content.Client.UserInterface
|
||||
ResetButton.OnPressed += OnResetButtonPressed;
|
||||
MasterVolumeSlider.OnValueChanged += OnMasterVolumeSliderChanged;
|
||||
AmbienceCheckBox.OnToggled += OnAmbienceCheckToggled;
|
||||
LobbyMusicCheckBox.OnToggled += OnLobbyMusicCheckToggled;
|
||||
|
||||
AddChild(vBox);
|
||||
|
||||
@@ -146,10 +152,16 @@ namespace Content.Client.UserInterface
|
||||
UpdateChanges();
|
||||
}
|
||||
|
||||
private void OnLobbyMusicCheckToggled(BaseButton.ButtonEventArgs args)
|
||||
{
|
||||
UpdateChanges();
|
||||
}
|
||||
|
||||
private void OnApplyButtonPressed(BaseButton.ButtonEventArgs args)
|
||||
{
|
||||
_cfg.SetCVar(CVars.AudioMasterVolume, MasterVolumeSlider.Value / 100);
|
||||
_cfg.SetCVar(CCVars.AmbienceBasicEnabled, AmbienceCheckBox.Pressed);
|
||||
_cfg.SetCVar(CCVars.LobbyMusicEnabled, LobbyMusicCheckBox.Pressed);
|
||||
_cfg.SaveToFile();
|
||||
UpdateChanges();
|
||||
}
|
||||
@@ -165,6 +177,7 @@ namespace Content.Client.UserInterface
|
||||
MasterVolumeLabel.Text =
|
||||
Loc.GetString("ui-options-volume-percent", ("volume", MasterVolumeSlider.Value / 100));
|
||||
AmbienceCheckBox.Pressed = _cfg.GetCVar(CCVars.AmbienceBasicEnabled);
|
||||
LobbyMusicCheckBox.Pressed = _cfg.GetCVar(CCVars.LobbyMusicEnabled);
|
||||
UpdateChanges();
|
||||
}
|
||||
|
||||
@@ -173,7 +186,8 @@ namespace Content.Client.UserInterface
|
||||
var isMasterVolumeSame =
|
||||
System.Math.Abs(MasterVolumeSlider.Value - _cfg.GetCVar(CVars.AudioMasterVolume) * 100) < 0.01f;
|
||||
var isAmbienceSame = AmbienceCheckBox.Pressed == _cfg.GetCVar(CCVars.AmbienceBasicEnabled);
|
||||
var isEverythingSame = isMasterVolumeSame && isAmbienceSame;
|
||||
var isLobbySame = LobbyMusicCheckBox.Pressed == _cfg.GetCVar(CCVars.LobbyMusicEnabled);
|
||||
var isEverythingSame = isMasterVolumeSame && isAmbienceSame && isLobbySame;
|
||||
ApplyButton.Disabled = isEverythingSame;
|
||||
ResetButton.Disabled = isEverythingSame;
|
||||
}
|
||||
|
||||
Reference in New Issue
Block a user