Random Announcer System [PORT]

Content.Client/Audio/ContentAudioSystem.cs

@@ -29,6 +29,7 @@ public sealed partial class ContentAudioSystem : SharedContentAudioSystem
     public const float AmbientMusicMultiplier = 3f;
     public const float LobbyMultiplier = 3f;
     public const float InterfaceMultiplier = 2f;
+    public const float AnnouncerMultiplier = 3f; // Impstation Random Announcer System
 
     public override void Initialize()
     {

Content.Client/Options/UI/Tabs/AudioTab.xaml

@@ -1,4 +1,4 @@
-<Control xmlns="https://spacestation14.io"
+<Control xmlns="https://spacestation14.io"
          xmlns:x="http://schemas.microsoft.com/winfx/2006/xaml"
          xmlns:ui="clr-namespace:Content.Client.Options.UI">
     <BoxContainer Orientation="Vertical">
@@ -13,11 +13,15 @@
                 <ui:OptionSlider Name="SliderVolumeAmbience" Title="{Loc 'ui-options-ambience-volume'}" />
                 <ui:OptionSlider Name="SliderVolumeLobby" Title="{Loc 'ui-options-lobby-volume'}" />
                 <ui:OptionSlider Name="SliderVolumeInterface" Title="{Loc 'ui-options-interface-volume'}" />
+                <ui:OptionSlider Name="SliderVolumeAnnouncer" Title="{Loc 'ui-options-announcer-volume'}" /> <!--Impstation Random Announcer System port-->
                 <ui:OptionSlider Name="SliderMaxAmbienceSounds" Title="{Loc 'ui-options-ambience-max-sounds'}"
                                  Margin="0 0 0 8" />
                 <CheckBox Name="LobbyMusicCheckBox" Text="{Loc 'ui-options-lobby-music'}" />
                 <CheckBox Name="RestartSoundsCheckBox" Text="{Loc 'ui-options-restart-sounds'}" />
                 <CheckBox Name="EventMusicCheckBox" Text="{Loc 'ui-options-event-music'}" />
+                <CheckBox Name="AnnouncerDisableMultipleSoundsCheckBox"
+                                Text="{Loc 'ui-options-announcer-disable-multiple-sounds'}"
+                                ToolTip="{Loc 'ui-options-announcer-disable-multiple-sounds-tooltip'}" /> <!--Impstation Random Announcer System port-->
                 <CheckBox Name="AdminSoundsCheckBox" Text="{Loc 'ui-options-admin-sounds'}" />
             </BoxContainer>
         </BoxContainer>

Content.Client/Options/UI/Tabs/AudioTab.xaml.cs

@@ -1,5 +1,6 @@
 using Content.Client.Audio;
 using Content.Shared.CCVar;
+using Content.Shared._Impstation.CCVar;
 using Robust.Client.Audio;
 using Robust.Client.AutoGenerated;
 using Robust.Client.UserInterface;
@@ -51,6 +52,11 @@ public AudioTab()
             SliderVolumeInterface,
             scale: ContentAudioSystem.InterfaceMultiplier);
 
+        Control.AddOptionPercentSlider( //Impstation Random Announcer System port start
+            ImpCCVars.AnnouncerVolume,
+            SliderVolumeAnnouncer,
+            scale: ContentAudioSystem.AnnouncerMultiplier); //Impstation Random Announcer System port end
+
         Control.AddOptionSlider(
             CCVars.MaxAmbientSources,
             SliderMaxAmbienceSounds,
@@ -60,6 +66,7 @@ public AudioTab()
         Control.AddOptionCheckBox(CCVars.LobbyMusicEnabled, LobbyMusicCheckBox);
         Control.AddOptionCheckBox(CCVars.RestartSoundsEnabled, RestartSoundsCheckBox);
         Control.AddOptionCheckBox(CCVars.EventMusicEnabled, EventMusicCheckBox);
+        Control.AddOptionCheckBox(ImpCCVars.AnnouncerDisableMultipleSounds, AnnouncerDisableMultipleSoundsCheckBox); //Impstation Random Announcer System
         Control.AddOptionCheckBox(CCVars.AdminSoundsEnabled, AdminSoundsCheckBox);
 
         Control.Initialize();

Content.Client/_EE/Announcements/Systems/AnnouncerSystem.cs

@@ -0,0 +1,100 @@
+using System.Linq;
+using Content.Client.Audio;
+using Content.Shared._EE.Announcements.Events;
+using Content.Shared._EE.Announcements.Systems;
+using Content.Shared.CCVar;
+using Content.Shared._Impstation.CCVar;
+using Robust.Client.Audio;
+using Robust.Client.Player;
+using Robust.Client.ResourceManagement;
+using Robust.Shared.Audio.Sources;
+using Robust.Shared.Audio.Systems;
+using Robust.Shared.Configuration;
+
+namespace Content.Client._EE.Announcements.Systems;
+
+public sealed class AnnouncerSystem : SharedAnnouncerSystem
+{
+    [Dependency] private readonly IPlayerManager _player = default!;
+    [Dependency] private readonly IConfigurationManager _config = default!;
+    [Dependency] private readonly IResourceCache _cache = default!;
+    [Dependency] private readonly IAudioManager _audioManager = default!;
+
+    public List<IAudioSource> AnnouncerSources { get; } = new();
+    public float AnnouncerVolume { get; private set; }
+
+
+    public override void Initialize()
+    {
+        base.Initialize();
+
+        AnnouncerVolume = _config.GetCVar(ImpCCVars.AnnouncerVolume) * 100f / ContentAudioSystem.AnnouncerMultiplier;
+
+        _config.OnValueChanged(ImpCCVars.AnnouncerVolume, OnAnnouncerVolumeChanged); // Impstation: Namespacing
+        _config.OnValueChanged(ImpCCVars.AnnouncerDisableMultipleSounds, OnAnnouncerDisableMultipleSounds);
+
+        SubscribeNetworkEvent<AnnouncementSendEvent>(OnAnnouncementReceived);
+    }
+
+    public override void Shutdown()
+    {
+        base.Shutdown();
+
+        _config.UnsubValueChanged(ImpCCVars.AnnouncerVolume, OnAnnouncerVolumeChanged); // Impstation: Namespacing
+        _config.UnsubValueChanged(ImpCCVars.AnnouncerDisableMultipleSounds, OnAnnouncerDisableMultipleSounds);
+    }
+
+
+    private void OnAnnouncerVolumeChanged(float value)
+    {
+        AnnouncerVolume = value;
+
+        foreach (var source in AnnouncerSources)
+            source.Gain = AnnouncerVolume;
+    }
+
+    private void OnAnnouncerDisableMultipleSounds(bool value)
+    {
+        if (!value)
+            return;
+
+        foreach (var audioSource in AnnouncerSources.ToList())
+        {
+            audioSource.Dispose();
+            AnnouncerSources.Remove(audioSource);
+        }
+    }
+
+    private void OnAnnouncementReceived(AnnouncementSendEvent ev)
+    {
+        if (!ev.Recipients.Contains(_player.LocalSession!.UserId)
+            || !_cache.TryGetResource<AudioResource>(GetAnnouncementPath(ev.AnnouncementId, ev.AnnouncerId),
+                out var resource))
+            return;
+
+        var source = _audioManager.CreateAudioSource(resource);
+        if (source == null)
+            return;
+
+        source.Gain = AnnouncerVolume * SharedAudioSystem.VolumeToGain(ev.AudioParams.Volume);
+        source.Global = true;
+
+        if (_config.GetCVar(ImpCCVars.AnnouncerDisableMultipleSounds)) // Impstation: Namespacing
+        {
+            foreach (var audioSource in AnnouncerSources.ToList())
+            {
+                audioSource.Dispose();
+                AnnouncerSources.Remove(audioSource);
+            }
+        }
+
+        foreach (var audioSource in AnnouncerSources.ToList().Where(audioSource => !audioSource.Playing))
+        {
+            audioSource.Dispose();
+            AnnouncerSources.Remove(audioSource);
+        }
+
+        AnnouncerSources.Add(source);
+        source.StartPlaying();
+    }
+}

Content.IntegrationTests/Tests/_EE/Announcers/AnnouncerAudioTest.cs

@@ -0,0 +1,76 @@
+using System.Collections.Generic;
+using System.Linq;
+using Content.Server._EE.Announcements.Systems;
+using Content.Server.StationEvents;
+using Content.Shared._EE.Announcements.Prototypes;
+using Robust.Client.ResourceManagement;
+using Robust.Shared.GameObjects;
+using Robust.Shared.IoC.Exceptions;
+using Robust.Shared.Localization;
+using Robust.Shared.Prototypes;
+using Serilog;
+
+namespace Content.IntegrationTests.Tests._EE.Announcers;
+
+/// <summary>
+///     Checks if every station event using the announcerSystem has a valid audio file associated with it
+/// </summary>
+[TestFixture]
+[TestOf(typeof(AnnouncerPrototype))]
+public sealed class AnnouncerAudioTest
+{
+    /// <inheritdoc cref="AnnouncerAudioTest" />
+    [Test]
+    public async Task TestEventSounds()
+    {
+        await using var pair = await PoolManager.GetServerClient(new PoolSettings { Connected = true });
+        var server = pair.Server;
+        var client = pair.Client;
+
+        var entSysMan = server.ResolveDependency<IEntitySystemManager>();
+        var proto = server.ResolveDependency<IPrototypeManager>();
+        var cache = client.ResolveDependency<IResourceCache>();
+        var announcer = entSysMan.GetEntitySystem<AnnouncerSystem>();
+        var events = entSysMan.GetEntitySystem<EventManagerSystem>();
+
+        await server.WaitAssertion(() =>
+        {
+            var succeeded = true;
+            var why = new List<string>();
+
+            foreach (var announcerProto in proto.EnumeratePrototypes<AnnouncerPrototype>().OrderBy(a => a.ID))
+            {
+                foreach (var ev in events.AllEvents())
+                {
+                    if (ev.Value.StartAnnouncement)
+                    {
+                        var announcementId = announcer.GetAnnouncementId(ev.Key.ID);
+                        var path = announcer.GetAnnouncementPath(announcementId, announcerProto);
+
+                        if (!cache.ContentFileExists(path))
+                        {
+                            succeeded = false;
+                            why.Add($"\"{announcerProto.ID}\", \"{announcementId}\": \"{path}\"");
+                        }
+                    }
+
+                    if (ev.Value.EndAnnouncement)
+                    {
+                        var announcementId = announcer.GetAnnouncementId(ev.Key.ID, true);
+                        var path = announcer.GetAnnouncementPath(announcementId, announcerProto);
+
+                        if (!cache.ContentFileExists(path))
+                        {
+                            succeeded = false;
+                            why.Add($"\"{announcerProto.ID}\", \"{announcementId}\": \"{path}\"");
+                        }
+                    }
+                }
+            }
+
+            Assert.That(succeeded, Is.True, $"The following announcements do not have a valid announcement audio:\n  {string.Join("\n  ", why)}");
+        });
+
+        await pair.CleanReturnAsync();
+    }
+}

Content.IntegrationTests/Tests/_EE/Announcers/AnnouncerFallbackTest.cs

@@ -0,0 +1,43 @@
+using System.Collections.Generic;
+using System.Linq;
+using Content.Shared._EE.Announcements.Prototypes;
+using Robust.Shared.Prototypes;
+
+namespace Content.IntegrationTests.Tests._EE.Announcers;
+
+/// <summary>
+///     Checks if every announcer has a fallback announcement
+/// </summary>
+[TestFixture]
+[TestOf(typeof(AnnouncerPrototype))]
+public sealed class AnnouncerPrototypeTest
+{
+    /// <inheritdoc cref="AnnouncerPrototypeTest"/>
+    [Test]
+    public async Task TestAnnouncerFallbacks()
+    {
+        await using var pair = await PoolManager.GetServerClient();
+        var server = pair.Server;
+
+        var prototype = server.ResolveDependency<IPrototypeManager>();
+
+        await server.WaitAssertion(() =>
+        {
+            var success = true;
+            var why = new List<string>();
+
+            foreach (var announcer in prototype.EnumeratePrototypes<AnnouncerPrototype>().OrderBy(a => a.ID))
+            {
+                if (announcer.Announcements.Any(a => a.ID.ToLower() == "fallback"))
+                    continue;
+
+                success = false;
+                why.Add(announcer.ID);
+            }
+
+            Assert.That(success, Is.True, $"The following announcers do not have a fallback announcement:\n  {string.Join("\n  ", why)}");
+        });
+
+        await pair.CleanReturnAsync();
+    }
+}

Content.IntegrationTests/Tests/_EE/Announcers/AnnouncerLocalizationTest.cs

@@ -0,0 +1,76 @@
+using System.Collections.Generic;
+using System.Linq;
+using Content.Server._EE.Announcements.Systems;
+using Content.Server.StationEvents;
+using Content.Shared._EE.Announcements.Prototypes;
+using Robust.Shared.GameObjects;
+using Robust.Shared.Localization;
+using Robust.Shared.Prototypes;
+
+namespace Content.IntegrationTests.Tests._EE.Announcers;
+
+/// <summary>
+///     Checks if every station event wanting the announcerSystem to send messages has a localization string
+///     If an event doesn't have startAnnouncement or endAnnouncement set to true
+///      it will be expected for that system to handle the announcements if it wants them
+/// </summary>
+[TestFixture]
+[TestOf(typeof(AnnouncerPrototype))]
+public sealed class AnnouncerLocalizationTest
+{
+    /// <inheritdoc cref="AnnouncerLocalizationTest"/>
+    [Test]
+    public async Task TestEventLocalization()
+    {
+        await using var pair = await PoolManager.GetServerClient();
+        var server = pair.Server;
+
+        var locale = server.ResolveDependency<ILocalizationManager>();
+        var entSysMan = server.ResolveDependency<IEntitySystemManager>();
+        var proto = server.ResolveDependency<IPrototypeManager>();
+        var announcer = entSysMan.GetEntitySystem<AnnouncerSystem>();
+        var events = entSysMan.GetEntitySystem<EventManagerSystem>();
+
+        await server.WaitAssertion(() =>
+        {
+            var succeeded = true;
+            var why = new List<string>();
+
+            foreach (var announcerProto in proto.EnumeratePrototypes<AnnouncerPrototype>().OrderBy(a => a.ID))
+            {
+                foreach (var ev in events.AllEvents())
+                {
+                    if (ev.Value.StartAnnouncement)
+                    {
+                        var announcementId = announcer.GetAnnouncementId(ev.Key.ID);
+                        var eventLocaleString = announcer.GetAnnouncementMessage(announcementId, announcerProto.ID)
+                            ?? announcer.GetEventLocaleString(announcementId);
+
+                        if (locale.GetString(eventLocaleString) == eventLocaleString)
+                        {
+                            succeeded = false;
+                            why.Add($"\"{announcerProto.ID}\", \"{announcementId}\": \"{eventLocaleString}\"");
+                        }
+                    }
+
+                    if (ev.Value.EndAnnouncement)
+                    {
+                        var announcementId = announcer.GetAnnouncementId(ev.Key.ID, true);
+                        var eventLocaleString = announcer.GetAnnouncementMessage(announcementId, announcerProto.ID)
+                            ?? announcer.GetEventLocaleString(announcementId);
+
+                        if (locale.GetString(eventLocaleString) == eventLocaleString)
+                        {
+                            succeeded = false;
+                            why.Add($"\"{announcerProto.ID}\", \"{announcementId}\": \"{eventLocaleString}\"");
+                        }
+                    }
+                }
+            }
+
+            Assert.That(succeeded, Is.True, $"The following announcements do not have a localization string:\n  {string.Join("\n  ", why)}");
+        });
+
+        await pair.CleanReturnAsync();
+    }
+}

Content.Server/Administration/UI/AdminAnnounceEui.cs

@@ -5,18 +5,22 @@
 using Content.Server.EUI;
 using Content.Shared.Administration;
 using Content.Shared.Eui;
+using Content.Server._EE.Announcements.Systems; // Impstation Random Announcer System
+using Robust.Shared.Player; // Impstation Random Announcer System
 
 namespace Content.Server.Administration.UI
 {
     public sealed class AdminAnnounceEui : BaseEui
     {
         [Dependency] private readonly IAdminManager _adminManager = default!;
         [Dependency] private readonly IChatManager _chatManager = default!;
+        private readonly AnnouncerSystem _announcer; // Impstation Random Announcer System
         private readonly ChatSystem _chatSystem;
 
         public AdminAnnounceEui()
         {
             IoCManager.InjectDependencies(this);
+            _announcer = IoCManager.Resolve<IEntitySystemManager>().GetEntitySystem<AnnouncerSystem>(); // Impstation Random Announcer System
             _chatSystem = IoCManager.Resolve<IEntitySystemManager>().GetEntitySystem<ChatSystem>();
         }
 
@@ -50,7 +54,8 @@ public override void HandleMessage(EuiMessageBase msg)
                             break;
                         // TODO: Per-station announcement support
                         case AdminAnnounceType.Station:
-                            _chatSystem.DispatchGlobalAnnouncement(doAnnounce.Announcement, doAnnounce.Announcer, colorOverride: Color.Gold);
+                            _announcer.SendAnnouncement(_announcer.GetAnnouncementId("Announce"), Filter.Broadcast(), // Impstation Random Announcer System
+                                doAnnounce.Announcement, doAnnounce.Announcer, Color.Gold);
                             break;
                     }