Add telecomms system (#14486)

Content.Server/Anomaly/AnomalySystem.Generator.cs

@@ -157,7 +157,7 @@ public sealed partial class AnomalySystem
         Audio.PlayPvs(component.GeneratingFinishedSound, uid);
 
         var message = Loc.GetString("anomaly-generator-announcement");
-        _radio.SendRadioMessage(uid, message, _prototype.Index<RadioChannelPrototype>(component.ScienceChannel));
+        _radio.SendRadioMessage(uid, message, _prototype.Index<RadioChannelPrototype>(component.ScienceChannel), uid);
     }
 
     private void UpdateGenerator()

Content.Server/Radio/EntitySystems/HeadsetSystem.cs

@@ -93,7 +93,7 @@ public sealed class HeadsetSystem : SharedHeadsetSystem
         }
     }
 
-    private void OnHeadsetReceive(EntityUid uid, HeadsetComponent component, RadioReceiveEvent args)
+    private void OnHeadsetReceive(EntityUid uid, HeadsetComponent component, ref RadioReceiveEvent args)
     {
         if (TryComp(Transform(uid).ParentUid, out ActorComponent? actor))
             _netMan.ServerSendMessage(args.ChatMsg, actor.PlayerSession.ConnectedClient);

Content.Server/Radio/EntitySystems/RadioDeviceSystem.cs

@@ -206,10 +206,10 @@ public sealed class RadioDeviceSystem : EntitySystem
         }
     }
 
-    private void OnReceiveRadio(EntityUid uid, RadioSpeakerComponent component, RadioReceiveEvent args)
+    private void OnReceiveRadio(EntityUid uid, RadioSpeakerComponent component, ref RadioReceiveEvent args)
     {
-        var nameEv = new TransformSpeakerNameEvent(args.Source, Name(args.Source));
+        var nameEv = new TransformSpeakerNameEvent(args.MessageSource, Name(args.MessageSource));
-        RaiseLocalEvent(args.Source, nameEv);
+        RaiseLocalEvent(args.MessageSource, nameEv);
 
         var name = Loc.GetString("speech-name-relay", ("speaker", Name(uid)),
             ("originalName", nameEv.Name));

Content.Server/Radio/EntitySystems/RadioSystem.cs

@@ -11,6 +11,9 @@ using Robust.Shared.Network;
 using Robust.Shared.Replays;
 using Robust.Shared.Utility;
 using Content.Shared.Popups;
+using Robust.Shared.Map;
+using Content.Shared.Radio.Components;
+using Content.Server.Power.Components;
 
 namespace Content.Server.Radio.EntitySystems;
 
@@ -22,7 +25,7 @@ public sealed class RadioSystem : EntitySystem
     [Dependency] private readonly INetManager _netMan = default!;
     [Dependency] private readonly IReplayRecordingManager _replay = default!;
     [Dependency] private readonly IAdminLogManager _adminLogger = default!;
-    [Dependency] private readonly PopupSystem _popupSystem = default!;
+    [Dependency] private readonly PopupSystem _popup = default!;
 
     // set used to prevent radio feedback loops.
     private readonly HashSet<string> _messages = new();
@@ -38,26 +41,31 @@ public sealed class RadioSystem : EntitySystem
     {
         if (args.Channel != null && component.Channels.Contains(args.Channel.ID))
         {
-            SendRadioMessage(uid, args.Message, args.Channel);
+            SendRadioMessage(uid, args.Message, args.Channel, uid);
             args.Channel = null; // prevent duplicate messages from other listeners.
         }
     }
 
-    private void OnIntrinsicReceive(EntityUid uid, IntrinsicRadioReceiverComponent component, RadioReceiveEvent args)
+    private void OnIntrinsicReceive(EntityUid uid, IntrinsicRadioReceiverComponent component, ref RadioReceiveEvent args)
     {
         if (TryComp(uid, out ActorComponent? actor))
             _netMan.ServerSendMessage(args.ChatMsg, actor.PlayerSession.ConnectedClient);
     }
 
-    public void SendRadioMessage(EntityUid source, string message, RadioChannelPrototype channel, EntityUid? radioSource = null)
+    /// <summary>
+    /// Send radio message to all active radio listeners
+    /// </summary>
+    /// <param name="messageSource">Entity that spoke the message</param>
+    /// <param name="radioSource">Entity that picked up the message and will send it, e.g. headset</param>
+    public void SendRadioMessage(EntityUid messageSource, string message, RadioChannelPrototype channel, EntityUid radioSource)
     {
         // TODO if radios ever garble / modify messages, feedback-prevention needs to be handled better than this.
         if (!_messages.Add(message))
             return;
 
-        var name = TryComp(source, out VoiceMaskComponent? mask) && mask.Enabled
+        var name = TryComp(messageSource, out VoiceMaskComponent? mask) && mask.Enabled
             ? mask.VoiceName
-            : MetaData(source).EntityName;
+            : MetaData(messageSource).EntityName;
 
         name = FormattedMessage.EscapeText(name);
 
@@ -68,37 +76,63 @@ public sealed class RadioSystem : EntitySystem
             Loc.GetString("chat-radio-message-wrap", ("color", channel.Color), ("channel", $"\\[{channel.LocalizedName}\\]"), ("name", name), ("message", FormattedMessage.EscapeText(message))),
             EntityUid.Invalid);
         var chatMsg = new MsgChatMessage { Message = chat };
+        var ev = new RadioReceiveEvent(message, messageSource, channel, chatMsg);
 
-        var ev = new RadioReceiveEvent(message, source, channel, chatMsg, radioSource);
+        var sourceMapId = Transform(radioSource).MapID;
-        var attemptEv = new RadioReceiveAttemptEvent(message, source, channel, radioSource);
+        var hasActiveServer = HasActiveServer(sourceMapId, channel.ID);
+        var hasMicro = HasComp<RadioMicrophoneComponent>(radioSource);
+
+        var speakerQuery = GetEntityQuery<RadioSpeakerComponent>();
+        var radioQuery = AllEntityQuery<ActiveRadioComponent, TransformComponent>();
         var sentAtLeastOnce = false;
-
+        while (radioQuery.MoveNext(out var receiver, out var radio, out var transform))
-        foreach (var radio in EntityQuery<ActiveRadioComponent>())
         {
-            var ent = radio.Owner;
-            // TODO map/station/range checks?
-
             if (!radio.Channels.Contains(channel.ID))
                 continue;
 
-            RaiseLocalEvent(ent, attemptEv);
+            if (!channel.LongRange && transform.MapID != sourceMapId)
-            if (attemptEv.Cancelled)
-            {
-                attemptEv.Uncancel();
                 continue;
-            }
+
+            // don't need telecom server for long range channels or handheld radios and intercoms
+            var needServer = !channel.LongRange && (!hasMicro || !speakerQuery.HasComponent(receiver));
+            if (needServer && !hasActiveServer)
+                continue;
+                
+            // check if message can be sent to specific receiver
+            var attemptEv = new RadioReceiveAttemptEvent(channel, radioSource, receiver);
+            RaiseLocalEvent(ref attemptEv);
+            if (attemptEv.Cancelled)
+                continue;
+
+            // send the message
+            RaiseLocalEvent(receiver, ref ev);
             sentAtLeastOnce = true;
-            RaiseLocalEvent(ent, ev);
         }
         if (!sentAtLeastOnce)
-            _popupSystem.PopupEntity(Loc.GetString("failed-to-send-message"), source, source, PopupType.MediumCaution);
+            _popup.PopupEntity(Loc.GetString("failed-to-send-message"), messageSource, messageSource, PopupType.MediumCaution);
 
-        if (name != Name(source))
+        if (name != Name(messageSource))
-            _adminLogger.Add(LogType.Chat, LogImpact.Low, $"Radio message from {ToPrettyString(source):user} as {name} on {channel.LocalizedName}: {message}");
+            _adminLogger.Add(LogType.Chat, LogImpact.Low, $"Radio message from {ToPrettyString(messageSource):user} as {name} on {channel.LocalizedName}: {message}");
         else
-            _adminLogger.Add(LogType.Chat, LogImpact.Low, $"Radio message from {ToPrettyString(source):user} on {channel.LocalizedName}: {message}");
+            _adminLogger.Add(LogType.Chat, LogImpact.Low, $"Radio message from {ToPrettyString(messageSource):user} on {channel.LocalizedName}: {message}");
 
         _replay.QueueReplayMessage(chat);
         _messages.Remove(message);
     }
+
+    /// <inheritdoc cref="TelecomServerComponent"/>
+    private bool HasActiveServer(MapId mapId, string channelId)
+    {
+        var servers = EntityQuery<TelecomServerComponent, EncryptionKeyHolderComponent, ApcPowerReceiverComponent, TransformComponent>();
+        foreach (var (_, keys, power, transform) in servers)
+        {
+            if (transform.MapID == mapId &&
+                power.Powered &&
+                keys.Channels.Contains(channelId))
+            {
+                return true;
+            }
+        }
+        return false;
+    }
 }

Content.Server/Radio/EntitySystems/TelecomSystem.cs

@@ -1,5 +0,0 @@
-namespace Content.Server.Radio.EntitySystems;
-
-public sealed class TelecomSystem : EntitySystem
-{
-}

Content.Server/Radio/RadioReceiveEvent.cs

@@ -3,36 +3,39 @@ using Content.Shared.Radio;
 
 namespace Content.Server.Radio;
 
-public sealed class RadioReceiveEvent : EntityEventArgs
+[ByRefEvent]
+public struct RadioReceiveEvent
 {
     public readonly string Message;
-    public readonly EntityUid Source;
+    public readonly EntityUid MessageSource;
     public readonly RadioChannelPrototype Channel;
     public readonly MsgChatMessage ChatMsg;
-    public readonly EntityUid? RadioSource;
 
-    public RadioReceiveEvent(string message, EntityUid source, RadioChannelPrototype channel, MsgChatMessage chatMsg, EntityUid? radioSource)
+    public RadioReceiveEvent(string message, EntityUid messageSource, RadioChannelPrototype channel, MsgChatMessage chatMsg)
     {
         Message = message;
-        Source = source;
+        MessageSource = messageSource;
         Channel = channel;
         ChatMsg = chatMsg;
-        RadioSource = radioSource;
     }
 }
 
-public sealed class RadioReceiveAttemptEvent : CancellableEntityEventArgs
+/// <summary>
+/// Use this event to cancel sending messages by doing various checks (e.g. range)
+/// </summary>
+[ByRefEvent]
+public struct RadioReceiveAttemptEvent
 {
-    public readonly string Message;
-    public readonly EntityUid Source;
     public readonly RadioChannelPrototype Channel;
-    public readonly EntityUid? RadioSource;
+    public readonly EntityUid RadioSource;
+    public readonly EntityUid RadioReceiver;
 
-    public RadioReceiveAttemptEvent(string message, EntityUid source, RadioChannelPrototype channel, EntityUid? radioSource)
+    public bool Cancelled = false;
+
+    public RadioReceiveAttemptEvent(RadioChannelPrototype channel, EntityUid radioSource, EntityUid radioReceiver)
     {
-        Message = message;
-        Source = source;
         Channel = channel;
         RadioSource = radioSource;
+        RadioReceiver = radioReceiver;
     }
 }

Content.Server/Salvage/SalvageSystem.cs

@@ -376,7 +376,7 @@ namespace Content.Server.Salvage
 
             var message = args.Length == 0 ? Loc.GetString(messageKey) : Loc.GetString(messageKey, args);
             var channel = _prototypeManager.Index<RadioChannelPrototype>(channelName);
-            _radioSystem.SendRadioMessage(source, message, channel);
+            _radioSystem.SendRadioMessage(source, message, channel, source);
         }
 
         private void Transition(SalvageMagnetComponent magnet, TimeSpan currentTime)

Content.Server/StationEvents/Events/SolarFlare.cs

@@ -23,7 +23,7 @@ public sealed class SolarFlare : StationEventSystem
     public override void Initialize()
     {
         base.Initialize();
-        SubscribeLocalEvent<ActiveRadioComponent, RadioReceiveAttemptEvent>(OnRadioSendAttempt);
+        SubscribeLocalEvent<RadioReceiveAttemptEvent>(OnRadioSendAttempt);
     }
 
     public override void Added()
@@ -69,10 +69,10 @@ public sealed class SolarFlare : StationEventSystem
         }
     }
 
-    private void OnRadioSendAttempt(EntityUid uid, ActiveRadioComponent component, RadioReceiveAttemptEvent args)
+    private void OnRadioSendAttempt(ref RadioReceiveAttemptEvent args)
     {
         if (RuleStarted && _event.AffectedChannels.Contains(args.Channel.ID))
-            if (!_event.OnlyJamHeadsets || (HasComp<HeadsetComponent>(uid) || HasComp<HeadsetComponent>(args.RadioSource)))
+            if (!_event.OnlyJamHeadsets || (HasComp<HeadsetComponent>(args.RadioReceiver) || HasComp<HeadsetComponent>(args.RadioSource)))
-                args.Cancel();
+                args.Cancelled = true;
     }
 }

Content.Shared/Radio/Components/TelecomServerComponent.cs

@@ -1,6 +1,12 @@
 namespace Content.Shared.Radio.Components;
 
+/// <summary>
+/// Entities with <see cref="TelecomServerComponent"/> are needed to transmit messages using headsets. 
+/// They also need to be powered by <see cref="ApcPowerReceiverComponent"/>
+/// have <see cref="EncryptionKeyHolderComponent"/> and filled with encryption keys
+/// of channels in order for them to work on the same map as server.
+/// </summary>
 [RegisterComponent]
 public sealed class TelecomServerComponent : Component
 {
-}
+}

Content.Shared/Radio/RadioChannelPrototype.cs

@@ -1,28 +1,38 @@
 using Robust.Shared.Prototypes;
 
-namespace Content.Shared.Radio
+namespace Content.Shared.Radio;
+
+[Prototype("radioChannel")]
+public sealed class RadioChannelPrototype : IPrototype
 {
-    [Prototype("radioChannel")]
+    /// <summary>
-    public sealed class RadioChannelPrototype : IPrototype
+    /// Human-readable name for the channel.
-    {
+    /// </summary>
-        /// <summary>
+    [DataField("name")]
-        /// Human-readable name for the channel.
+    public string Name { get; private set; } = string.Empty;
-        /// </summary>
-        [DataField("name")] public string Name { get; private set; } = string.Empty;
 
-        [ViewVariables(VVAccess.ReadOnly)] public string LocalizedName => Loc.GetString(Name);
+    [ViewVariables(VVAccess.ReadOnly)]
+    public string LocalizedName => Loc.GetString(Name);
 
-        /// <summary>
+    /// <summary>
-        /// Single-character prefix to determine what channel a message should be sent to.
+    /// Single-character prefix to determine what channel a message should be sent to.
-        /// </summary>
+    /// </summary>
-        [DataField("keycode")] public char KeyCode { get; private set; } = '\0';
+    [DataField("keycode")]
+    public char KeyCode { get; private set; } = '\0';
 
-        [DataField("frequency")] public int Frequency { get; private set; } = 0;
+    [DataField("frequency")]
+    public int Frequency { get; private set; } = 0;
 
-        [DataField("color")] public Color Color { get; private set; } = Color.Lime;
+    [DataField("color")]
+    public Color Color { get; private set; } = Color.Lime;
 
-        [ViewVariables]
+    [IdDataField, ViewVariables]
-        [IdDataField]
+    public string ID { get; } = default!;
-        public string ID { get; } = default!;
+
-    }
+    /// <summary>
+    /// If channel is long range it doesn't require telecommunication server 
+    /// and messages can be sent across different stations
+    /// </summary>
+    [DataField("longRange"), ViewVariables]
+    public bool LongRange = false;
 }

Resources/Prototypes/radio_channels.yml

@@ -11,6 +11,7 @@
   keycode: 'y'
   frequency: 1337
   color: "#2681a5"
+  longRange: true
 
 - type: radioChannel
   id: Command
@@ -67,3 +68,4 @@
   keycode: 't'
   frequency: 1213
   color: "#8f4a4b"
+  longRange: true