Hallway textscreens (#24189)

* hallway screen refactor pending comms console support * comms console broadcasts * screen and timer localization
2024-01-27 05:51:24 -08:00
parent a923beb21b
commit 7e16ee0b55
23 changed files with 318 additions and 142 deletions
--- a/Content.Server/Screens/Systems/ScreenSystem.cs
+++ b/Content.Server/Screens/Systems/ScreenSystem.cs
@@ -0,0 +1,114 @@
+using Content.Shared.TextScreen;
+using Content.Server.Screens.Components;
+using Content.Server.DeviceNetwork.Components;
+using Content.Server.DeviceNetwork.Systems;
+using Robust.Shared.Timing;
+
+
+namespace Content.Server.Screens.Systems;
+
+/// <summary>
+/// Controls the wallmounted screens on stations and shuttles displaying e.g. FTL duration, ETA
+/// </summary>
+public sealed class ScreenSystem : EntitySystem
+{
+    [Dependency] private readonly IGameTiming _gameTiming = default!;
+    [Dependency] private readonly SharedAppearanceSystem _appearanceSystem = default!;
+
+    public override void Initialize()
+    {
+        base.Initialize();
+
+        SubscribeLocalEvent<ScreenComponent, DeviceNetworkPacketEvent>(OnPacketReceived);
+    }
+
+    /// <summary>
+    ///     Calls either a normal screen text update or shuttle timer update based on the presence of
+    ///     <see cref="ShuttleTimerMasks.ShuttleMap"/> in <see cref="args.Data"/>
+    /// </summary>
+    private void OnPacketReceived(EntityUid uid, ScreenComponent component, DeviceNetworkPacketEvent args)
+    {
+        if (args.Data.TryGetValue(ShuttleTimerMasks.ShuttleMap, out _))
+            ShuttleTimer(uid, component, args);
+        else
+            ScreenText(uid, component, args);
+    }
+
+    /// <summary>
+    ///     Send a text update to every screen on the same MapUid as the originating comms console.
+    /// </summary>
+    private void ScreenText(EntityUid uid, ScreenComponent component, DeviceNetworkPacketEvent args)
+    {
+        // don't allow text updates if there's an active timer
+        // (and just check here so the server doesn't have to track them)
+        if (_appearanceSystem.TryGetData(uid, TextScreenVisuals.TargetTime, out TimeSpan target)
+            && target > _gameTiming.CurTime)
+            return;
+
+        var screenMap = Transform(uid).MapUid;
+        var argsMap = Transform(args.Sender).MapUid;
+
+        if (screenMap != null
+            && argsMap != null
+            && screenMap == argsMap
+            && args.Data.TryGetValue(ScreenMasks.Text, out string? text)
+            && text != null
+            )
+        {
+            _appearanceSystem.SetData(uid, TextScreenVisuals.DefaultText, text);
+        }
+    }
+
+    /// <summary>
+    /// Determines if/how a timer packet affects this screen.
+    /// Currently there are 2 broadcast domains: Arrivals, and every other screen.
+    /// Domain is determined by the <see cref="DeviceNetworkComponent.TransmitFrequencyId"/> on each timer.
+    /// Each broadcast domain is divided into subnets. Screen MapUid determines subnet.
+    /// Subnets are the shuttle, source, and dest. Source/dest change each jump.
+    /// This is required to send different timers to the shuttle/terminal/station.
+    /// </summary>
+    private void ShuttleTimer(EntityUid uid, ScreenComponent component, DeviceNetworkPacketEvent args)
+    {
+        var timerXform = Transform(uid);
+
+        // no false positives.
+        if (timerXform.MapUid == null)
+            return;
+
+        string key;
+        args.Data.TryGetValue(ShuttleTimerMasks.ShuttleMap, out EntityUid? shuttleMap);
+        args.Data.TryGetValue(ShuttleTimerMasks.SourceMap, out EntityUid? source);
+        args.Data.TryGetValue(ShuttleTimerMasks.DestMap, out EntityUid? dest);
+        args.Data.TryGetValue(ShuttleTimerMasks.Docked, out bool docked);
+        string text = docked ? ShuttleTimerMasks.ETD : ShuttleTimerMasks.ETA;
+
+        switch (timerXform.MapUid)
+        {
+            // sometimes the timer transforms on FTL shuttles have a hyperspace mapuid, so matching by grid works as a fallback.
+            case var local when local == shuttleMap || timerXform.GridUid == shuttleMap:
+                key = ShuttleTimerMasks.ShuttleTime;
+                break;
+            case var origin when origin == source:
+                key = ShuttleTimerMasks.SourceTime;
+                break;
+            case var remote when remote == dest:
+                key = ShuttleTimerMasks.DestTime;
+                text = ShuttleTimerMasks.ETA;
+                break;
+            default:
+                return;
+        }
+
+        if (!args.Data.TryGetValue(key, out TimeSpan duration))
+            return;
+
+        if (args.Data.TryGetValue(ScreenMasks.Text, out string? label) && label != null)
+            text = label;
+
+        _appearanceSystem.SetData(uid, TextScreenVisuals.ScreenText, text);
+        _appearanceSystem.SetData(uid, TextScreenVisuals.TargetTime, _gameTiming.CurTime + duration);
+
+        if (args.Data.TryGetValue(ScreenMasks.Color, out Color color))
+            _appearanceSystem.SetData(uid, TextScreenVisuals.Color, color);
+    }
+}