Fix forensic scanner UI. (#12398)

* Add missing Dispose method to ForensicScannerBoundUserInterface.

* Remove old code from ForensicScanner.

* Prevent forensic scanner from being used on the floor and allow its window to stay open when active hand is swapped.

* Use more standardized UI code for ForensicScanner.

* Add a delay to ForensicScanner printing.

* Show name of what was scanned on ForensicScanner UI.

* Add a print sound for ForensicScanner.

* Add more error reporting for ForensicScanner.

* Centralize common logic in ForensicScannerSystem.

* Allow ForensicScanner blank printouts.

* Tweak ForensicScanner audio parameters.

Content.Client/Forensics/ForensicScannerBoundUserInterface.cs

@@ -1,12 +1,17 @@
-using Content.Shared.Forensics;
 using Robust.Client.GameObjects;
+using Robust.Shared.Timing;
+using Content.Shared.Forensics;
 
 namespace Content.Client.Forensics
 {
     public sealed class ForensicScannerBoundUserInterface : BoundUserInterface
     {
+        [Dependency] private readonly IGameTiming _gameTiming = default!;
+
         private ForensicScannerMenu? _window;
 
+        private TimeSpan _printCooldown;
+
         public ForensicScannerBoundUserInterface(ClientUserInterfaceComponent owner, Enum uiKey) : base(owner, uiKey)
         {
         }
@@ -17,24 +22,61 @@ namespace Content.Client.Forensics
             _window = new ForensicScannerMenu();
             _window.OnClose += Close;
             _window.Print.OnPressed += _ => Print();
+            _window.Clear.OnPressed += _ => Clear();
             _window.OpenCentered();
         }
 
         private void Print()
         {
             SendMessage(new ForensicScannerPrintMessage());
-            _window?.Close();
+
+            if (_window != null)
+                _window.UpdatePrinterState(true);
+
+            // This UI does not require pinpoint accuracy as to when the Print
+            // button is available again, so spawning client-side timers is
+            // fine. The server will make sure the cooldown is honored.
+            Timer.Spawn(_printCooldown, () =>
+            {
+                if (_window != null)
+                    _window.UpdatePrinterState(false);
+            });
         }
 
-        protected override void ReceiveMessage(BoundUserInterfaceMessage message)
+        private void Clear()
         {
+            SendMessage(new ForensicScannerClearMessage());
+        }
+
+        protected override void UpdateState(BoundUserInterfaceState state)
+        {
+            base.UpdateState(state);
+
             if (_window == null)
                 return;
 
-            if (message is not ForensicScannerUserMessage cast)
+            if (state is not ForensicScannerBoundUserInterfaceState cast)
                 return;
 
-            _window.Populate(cast);
+            _printCooldown = cast.PrintCooldown;
+
+            if (cast.PrintReadyAt > _gameTiming.CurTime)
+                Timer.Spawn(cast.PrintReadyAt - _gameTiming.CurTime, () =>
+                {
+                    if (_window != null)
+                        _window.UpdatePrinterState(false);
+                });
+
+            _window.UpdateState(cast);
+        }
+
+        protected override void Dispose(bool disposing)
+        {
+            base.Dispose(disposing);
+            if (!disposing)
+                return;
+
+            _window?.Dispose();
         }
     }
 }

Content.Client/Forensics/ForensicScannerMenu.xaml

@@ -1,12 +1,25 @@
 <DefaultWindow xmlns="https://spacestation14.io"
             Title="{Loc 'forensic-scanner-interface-title'}"
-            MinSize="250 100"
-            SetSize="250 100">
+            MinSize="350 200"
+            SetSize="350 500">
     <BoxContainer Orientation="Vertical">
-        <Button Name="Print"
+        <BoxContainer Orientation="Horizontal">
+            <Button Name="Print"
+                TextAlign="Center"
+                HorizontalExpand="True"
                 Access="Public"
                 Disabled="True"
                 Text="{Loc 'forensic-scanner-interface-print'}" />
+            <Button Name="Clear"
+                TextAlign="Center"
+                HorizontalExpand="True"
+                Access="Public"
+                Disabled="True"
+                Text="{Loc 'forensic-scanner-interface-clear'}" />
+        </BoxContainer>
+        <Label
+            Name="Name"
+            Align="Center" />
         <Label
             Name="Diagnostics"
             Text="{Loc forensic-scanner-interface-no-data}"/>

Content.Client/Forensics/ForensicScannerMenu.xaml.cs

@@ -1,22 +1,44 @@
 using System.Text;
-using Content.Shared.Forensics;
 using Robust.Client.AutoGenerated;
 using Robust.Client.UserInterface.CustomControls;
 using Robust.Client.UserInterface.XAML;
+using Robust.Shared.Timing;
+using Content.Shared.Forensics;
 
 namespace Content.Client.Forensics
 {
     [GenerateTypedNameReferences]
     public sealed partial class ForensicScannerMenu : DefaultWindow
     {
+        [Dependency] private readonly IGameTiming _gameTiming = default!;
+
         public ForensicScannerMenu()
         {
             RobustXamlLoader.Load(this);
+            IoCManager.InjectDependencies(this);
         }
 
-        public void Populate(ForensicScannerUserMessage msg)
+        public void UpdatePrinterState(bool disabled)
         {
-            Print.Disabled = false;
+            Print.Disabled = disabled;
+        }
+
+        public void UpdateState(ForensicScannerBoundUserInterfaceState msg)
+        {
+            if (string.IsNullOrEmpty(msg.LastScannedName))
+            {
+                Print.Disabled = true;
+                Clear.Disabled = true;
+                Name.Text = string.Empty;
+                Diagnostics.Text = string.Empty;
+                return;
+            }
+
+            Print.Disabled = (msg.PrintReadyAt > _gameTiming.CurTime);
+            Clear.Disabled = false;
+
+            Name.Text = msg.LastScannedName;
+
             var text = new StringBuilder();
 
             text.AppendLine(Loc.GetString("forensic-scanner-interface-fingerprints"));
@@ -31,7 +53,6 @@ namespace Content.Client.Forensics
                 text.AppendLine(fiber);
             }
             Diagnostics.Text = text.ToString();
-            SetSize = (350, 600);
         }
     }
 }