Security Hailer

Content.Server/Chat/Systems/ChatSystem.cs

@@ -137,6 +137,8 @@ private void OnGameChange(GameRunLevelChangedEvent ev)
     /// <param name="shell"></param>
     /// <param name="player">The player doing the speaking</param>
     /// <param name="nameOverride">The name to use for the speaking entity. Usually this should just be modified via <see cref="TransformSpeakerNameEvent"/>. If this is set, the event will not get raised.</param>
+    /// <param name="ignoreActionBlocker">If set to true, action blocker will not be considered for whether an entity can send this message.</param>
+    /// <param name="skipTransform">Skips the transformation of the message sent, by accents for example.</param>
     public void TrySendInGameICMessage(
         EntityUid source,
         string message,
@@ -145,9 +147,11 @@ public void TrySendInGameICMessage(
         IConsoleShell? shell = null,
         ICommonSession? player = null, string? nameOverride = null,
         bool checkRadioPrefix = true,
-        bool ignoreActionBlocker = false)
+        bool ignoreActionBlocker = false,
+        bool skipTransform = false)
     {
-        TrySendInGameICMessage(source, message, desiredType, hideChat ? ChatTransmitRange.HideChat : ChatTransmitRange.Normal, hideLog, shell, player, nameOverride, checkRadioPrefix, ignoreActionBlocker);
+        TrySendInGameICMessage(source, message, desiredType, hideChat ? ChatTransmitRange.HideChat : ChatTransmitRange.Normal, hideLog, shell, player, nameOverride,
+            checkRadioPrefix, ignoreActionBlocker, skipTransform);
     }
 
     /// <summary>
@@ -161,6 +165,7 @@ public void TrySendInGameICMessage(
     /// <param name="player">The player doing the speaking</param>
     /// <param name="nameOverride">The name to use for the speaking entity. Usually this should just be modified via <see cref="TransformSpeakerNameEvent"/>. If this is set, the event will not get raised.</param>
     /// <param name="ignoreActionBlocker">If set to true, action blocker will not be considered for whether an entity can send this message.</param>
+    /// <param name="skipTransform">Skips the transformation of the message sent, by accents for example.</param>
     public void TrySendInGameICMessage(
         EntityUid source,
         string message,
@@ -171,7 +176,8 @@ public void TrySendInGameICMessage(
         ICommonSession? player = null,
         string? nameOverride = null,
         bool checkRadioPrefix = true,
-        bool ignoreActionBlocker = false
+        bool ignoreActionBlocker = false,
+        bool skipTransform = false
         )
     {
         if (HasComp<GhostComponent>(source))
@@ -247,7 +253,7 @@ public void TrySendInGameICMessage(
         switch (desiredType)
         {
             case InGameICChatType.Speak:
-                SendEntitySpeak(source, message, range, nameOverride, hideLog, ignoreActionBlocker);
+                SendEntitySpeak(source, message, range, nameOverride, hideLog, ignoreActionBlocker, skipTransform);
                 break;
             case InGameICChatType.Whisper:
                 SendEntityWhisper(source, message, range, null, nameOverride, hideLog, ignoreActionBlocker);
@@ -414,13 +420,14 @@ private void SendEntitySpeak(
         ChatTransmitRange range,
         string? nameOverride,
         bool hideLog = false,
-        bool ignoreActionBlocker = false
+        bool ignoreActionBlocker = false,
+        bool skipTransform = false
         )
     {
         if (!_actionBlocker.CanSpeak(source) && !ignoreActionBlocker)
             return;
 
-        var message = TransformSpeech(source, originalMessage);
+        var message = skipTransform ? originalMessage : TransformSpeech(source, originalMessage);
 
         if (message.Length == 0)
             return;

Content.Server/Clothing/Systems/SecurityHailerSystem.cs

@@ -0,0 +1,108 @@
+using Content.Shared.Clothing.ActionEvent;
+using Content.Shared.Clothing.Components;
+using Content.Shared.Clothing.EntitySystems;
+using Content.Server.Chat.Systems;
+using Robust.Server.Audio;
+using Robust.Shared.Audio;
+using Content.Shared.Emag.Components;
+
+namespace Content.Server.Clothing.Systems
+{
+    public sealed class SecurityHailerSystem : SharedSecurityHailerSystem
+    {
+        [Dependency] private readonly ChatSystem _chat = default!;
+        [Dependency] private readonly AudioSystem _audio = default!;
+        private readonly (string, string) _replaceLineHos = ("hail-high-8", "hail-high-HOS"); //the line to replace if a HOS gas mask hails
+
+        public override void Initialize()
+        {
+            base.Initialize();
+            SubscribeLocalEvent<SecurityHailerComponent, ActionSecHailerActionEvent>(OnHailOrder);
+        }
+
+        private void OnHailOrder(Entity<SecurityHailerComponent> ent, ref ActionSecHailerActionEvent ev)
+        {
+            //If the event is already handled
+            if (ev.Handled)
+                return;
+
+            //Put the exclamations mark around people at the distance specified in the comp side
+            //Just like a whistle
+            bool exclamationHandled = base.ExclamateHumanoidsAround(ent);
+
+            //Play the damn sound
+            int index = PlaySoundEffect(ent); // index gotten from AudioSystem.ResolveSound() of the sound chosen in the soundcollection (Basically, which random line is playing ?)
+            bool chatHandled = SayChatMessage(ent, ev, index);
+
+            //If both exclamation and chat were done, we handled it yay !
+            ev.Handled = exclamationHandled && chatHandled;
+        }
+
+        private bool SayChatMessage(Entity<SecurityHailerComponent> ent, ActionSecHailerActionEvent ev, int index)
+        {
+            string ftlLine = GetTheCorrectLine(ent, index);
+            if (IsVoiceReplaced(ent, index)) //This is some bandaid code, replace it omg
+                ftlLine = _replaceLineHos.Item2;
+
+            //Make a chat line with the sec hailer as speaker, in bold and UPPERCASE for added impact
+            _chat.TrySendInGameICMessage(ev.Performer, Loc.GetString(ftlLine).ToUpper(), InGameICChatType.Speak, hideChat: false, hideLog: true, nameOverride: ent.Comp.ChatName,
+            checkRadioPrefix: false, ignoreActionBlocker: true, skipTransform: true);
+            return true;
+        }
+
+        private int PlaySoundEffect(Entity<SecurityHailerComponent> ent)
+        {
+            var (uid, comp) = ent;
+
+            SoundSpecifier currentSpecifier;
+            if (comp.SpecialCircumtance == SecurityHailerComponent.SpecialUseCase.ERT)
+                currentSpecifier = comp.ERTAggressionSounds;
+            else if (HasComp<EmaggedComponent>(ent))
+                currentSpecifier = ent.Comp.EmagAggressionSounds;
+            else
+            {
+                currentSpecifier = comp.AggresionLevel switch
+                {
+                    SecurityHailerComponent.AggresionState.Medium => comp.MediumAggressionSounds,
+                    SecurityHailerComponent.AggresionState.High => comp.HighAggressionSounds,
+                    _ => comp.LowAggressionSounds,
+                };
+            }
+            var resolver = _audio.ResolveSound(currentSpecifier);
+            if (resolver is not ResolvedCollectionSpecifier collectionResolver)
+                return -1;
+
+            if (IsVoiceReplaced(ent, collectionResolver.Index))
+            {
+                collectionResolver = (ResolvedCollectionSpecifier)_audio.ResolveSound(comp.HOSReplaceSounds); //add a check ? What to do if multiple in future ?
+            }
+
+            _audio.PlayPvs(resolver, ent.Owner, audioParams: new AudioParams().WithVolume(-3f));
+
+            return collectionResolver.Index;
+        }
+
+        private bool IsVoiceReplaced(Entity<SecurityHailerComponent> ent, int index)
+        {
+            if (ent.Comp.SpecialCircumtance == SecurityHailerComponent.SpecialUseCase.HOS && GetTheCorrectLine(ent, index) == _replaceLineHos.Item1)
+            {
+                return true;
+            }
+
+            return false;
+        }
+
+        private string GetTheCorrectLine(Entity<SecurityHailerComponent> ent, int index)
+        {
+            string finalLine = String.Empty;
+            if (HasComp<EmaggedComponent>(ent))
+                finalLine = $"hail-emag-{index}";
+            else if (ent.Comp.SpecialCircumtance == SecurityHailerComponent.SpecialUseCase.ERT)
+                finalLine = $"hail-ERT-{index}";
+            else
+                finalLine = $"hail-{ent.Comp.AggresionLevel.ToString().ToLower()}-{index}";
+
+            return finalLine;
+        }
+    }
+}

Content.Server/Fax/FaxSystem.cs

@@ -209,7 +209,7 @@ private void OnInteractUsing(EntityUid uid, FaxMachineComponent component, Inter
     {
         if (args.Handled ||
             !TryComp<ActorComponent>(args.User, out var actor) ||
-            !_toolSystem.HasQuality(args.Used, "Screwing")) // Screwing because Pulsing already used by device linking
+            !_toolSystem.HasQuality(args.Used, ToolSystem.ScrewQuality)) // Screwing because Pulsing already used by device linking
             return;
 
         _quickDialog.OpenDialog(actor.PlayerSession,

Content.Shared/Clothing/Components/SecurityHailerComponent.cs

@@ -0,0 +1,113 @@
+using Robust.Shared.Audio;
+using Robust.Shared.GameStates;
+using Robust.Shared.Prototypes;
+using Robust.Shared.Serialization;
+
+
+namespace Content.Shared.Clothing.Components
+{
+    /// <summary>
+    /// Handle the hails (audible orders to stop) coming from a security gas mask / swat mask
+    /// </summary>
+    [RegisterComponent, NetworkedComponent, AutoGenerateComponentState]
+    public sealed partial class SecurityHailerComponent : Component
+    {
+        /// <summary>
+        /// 
+        /// </summary>
+        [DataField]
+        public SecMaskState CurrentState = SecMaskState.Functional;
+
+        /// <summary>
+        /// Range value
+        /// </summary>
+        [DataField]
+        public float Distance = 0;
+
+        /// <summary>
+        /// The name displayed as the speaker when hailing orders
+        /// </summary>
+        [DataField]
+        public string? ChatName = "Security Hailer";
+
+        /// <summary>
+        /// Delay when the hailer is screwed to change aggression level
+        /// </summary>
+        [DataField]
+        public float ScrewingDoAfterDelay = 1f;
+
+        public enum SpecialUseCase : byte
+        {
+            None = 0,
+            HOS = 1,
+            ERT = 2
+        }
+
+        /// <summary>
+        /// Special use cases where some voicelines shouldn't play or we want to play some other voicelines, ex: HOS or ERT
+        /// </summary>
+        [DataField]
+        public SpecialUseCase SpecialCircumtance = SpecialUseCase.None;
+
+        /// <summary>
+        /// What ftl line to replace in special circumstances
+        /// </summary>
+        public Dictionary<SpecialUseCase, (string[], string[])> ReplaceVoicelinesSpecial = new() //List of Tuples
+        {
+            { SpecialUseCase.HOS, (["hail-high-8"], ["hail-high-HOS"]) }//"Take it to the HOS voice" line, make no sense if HOS
+        };
+
+        /// <summary>
+        /// How aggresive are the orders coming from the hailer ? Higher means more aggressive / shitsec
+        /// </summary>
+        public enum AggresionState : byte
+        {
+            Low = 0,
+            Medium = 1,
+            High = 2
+        }
+
+        [DataField, AutoNetworkedField]
+        public AggresionState AggresionLevel = AggresionState.Low;
+
+        public SoundSpecifier LowAggressionSounds = new SoundCollectionSpecifier("SecHailLow");
+        public SoundSpecifier MediumAggressionSounds = new SoundCollectionSpecifier("SecHailMedium");
+        public SoundSpecifier HighAggressionSounds = new SoundCollectionSpecifier("SecHailHigh");
+        public SoundSpecifier EmagAggressionSounds = new SoundCollectionSpecifier("SecHailEmag");
+        public SoundSpecifier ERTAggressionSounds = new SoundCollectionSpecifier("SecHailERT");
+        public SoundSpecifier HOSReplaceSounds = new SoundCollectionSpecifier("SecHailHOS");
+        public SoundSpecifier ScrewedSounds = new SoundCollectionSpecifier("Screwdriver"); //From the soundcollection of tools
+        public SoundSpecifier CutSounds = new SoundCollectionSpecifier("Wirecutter"); //From the soundcollection of tools
+
+        /// <summary>
+        ///     The action that gets displayed when the gas mask is equipped.
+        /// </summary>
+        [DataField]
+        public EntProtoId Action = "ActionSecHailer";
+
+        /// <summary>
+        ///     Reference to the action.
+        /// </summary>
+        [DataField]
+        public EntityUid? ActionEntity;
+
+        /// <summary>
+        /// Entity prototype to spawn when used, using the whistle one
+        /// </summary>
+        [DataField]
+        public EntProtoId ExclamationEffect = "WhistleExclamation";
+    }
+
+    [Serializable, NetSerializable]
+    public enum SecMaskVisuals : byte
+    {
+        State
+    }
+
+    [Serializable, NetSerializable]
+    public enum SecMaskState : byte
+    {
+        Functional,
+        WiresCut
+    }
+}