PDA UI refactor and cartridges (#11335)

* Work on cartridges * Work on PDA UI * Work on PDA UIs program list * Work on PDA UI borders * Add DeviceNetworkingComponent to the pda base prototype * Fix submodule version * Fix cartridge loader ui key * Fix pda menu xaml * Implement relaying ui messages * Finish implementing the notekeeper cartridge * Fix submodule version * Fix errors from merging master * Fix test failing * Implement setting preinstalled programs * Add some documentation to CartridgeLoaderSystem * Add more doc comments * Add localization to program names * Implement review suggestions * Fix background programs receiving events twice when active
2022-11-08 21:00:20 +01:00
parent 1151ca42e5
commit e11cf969fa
79 changed files with 2323 additions and 94 deletions
--- a/Content.Client/CartridgeLoader/CartridgeLoaderBoundUserInterface.cs
+++ b/Content.Client/CartridgeLoader/CartridgeLoaderBoundUserInterface.cs
@@ -0,0 +1,136 @@
+using Content.Shared.CartridgeLoader;
+using Robust.Client.GameObjects;
+using Robust.Client.UserInterface;
+
+namespace Content.Client.CartridgeLoader;
+
+
+public abstract class CartridgeLoaderBoundUserInterface : BoundUserInterface
+{
+    [Dependency] private readonly IEntityManager? _entityManager = default!;
+
+    private EntityUid? _activeProgram;
+    private CartridgeUI? _activeCartridgeUI;
+    private Control? _activeUiFragment;
+
+    protected CartridgeLoaderBoundUserInterface(ClientUserInterfaceComponent owner, Enum uiKey) : base(owner, uiKey)
+    {
+        IoCManager.InjectDependencies(this);
+    }
+
+    protected override void UpdateState(BoundUserInterfaceState state)
+    {
+        base.UpdateState(state);
+
+        if (state is not CartridgeLoaderUiState loaderUiState)
+        {
+            _activeCartridgeUI?.UpdateState(state);
+            return;
+        }
+
+        var programs = GetCartridgeComponents(loaderUiState.Programs);
+        UpdateAvailablePrograms(programs);
+
+        _activeProgram = loaderUiState.ActiveUI;
+
+        var ui = RetrieveCartridgeUI(loaderUiState.ActiveUI);
+        var comp = RetrieveCartridgeComponent(loaderUiState.ActiveUI);
+        var control = ui?.GetUIFragmentRoot();
+
+        //Prevent the same UI fragment from getting disposed and attached multiple times
+        if (_activeUiFragment?.GetType() == control?.GetType())
+            return;
+
+        if (_activeUiFragment is not null)
+            DetachCartridgeUI(_activeUiFragment);
+
+        if (control is not null && _activeProgram.HasValue)
+        {
+            AttachCartridgeUI(control, Loc.GetString(comp?.ProgramName ?? "default-program-name"));
+            SendCartridgeUiReadyEvent(_activeProgram.Value);
+        }
+
+        _activeCartridgeUI = ui;
+        _activeUiFragment?.Dispose();
+        _activeUiFragment = control;
+    }
+
+    protected void ActivateCartridge(EntityUid cartridgeUid)
+    {
+        var message = new CartridgeLoaderUiMessage(cartridgeUid, CartridgeUiMessageAction.Activate);
+        SendMessage(message);
+    }
+
+    protected void DeactivateActiveCartridge()
+    {
+        if (!_activeProgram.HasValue)
+            return;
+
+        var message = new CartridgeLoaderUiMessage(_activeProgram.Value, CartridgeUiMessageAction.Deactivate);
+        SendMessage(message);
+    }
+
+    protected void InstallCartridge(EntityUid cartridgeUid)
+    {
+        var message = new CartridgeLoaderUiMessage(cartridgeUid, CartridgeUiMessageAction.Install);
+        SendMessage(message);
+    }
+
+    protected void UninstallCartridge(EntityUid cartridgeUid)
+    {
+        var message = new CartridgeLoaderUiMessage(cartridgeUid, CartridgeUiMessageAction.Uninstall);
+        SendMessage(message);
+    }
+
+    private List<(EntityUid, CartridgeComponent)> GetCartridgeComponents(List<EntityUid> programs)
+    {
+        var components = new List<(EntityUid, CartridgeComponent)>();
+
+        foreach (var program in programs)
+        {
+            var component = RetrieveCartridgeComponent(program);
+            if (component is not null)
+                components.Add((program, component));
+        }
+
+        return components;
+    }
+
+    /// <summary>
+    /// The implementing ui needs to add the passed ui fragment as a child to itself
+    /// </summary>
+    protected abstract void AttachCartridgeUI(Control cartridgeUIFragment, string? title);
+
+    /// <summary>
+    /// The implementing ui needs to remove the passed ui from itself
+    /// </summary>
+    protected abstract void DetachCartridgeUI(Control cartridgeUIFragment);
+
+    protected abstract void UpdateAvailablePrograms(List<(EntityUid, CartridgeComponent)> programs);
+
+    protected override void Dispose(bool disposing)
+    {
+        base.Dispose(disposing);
+
+        if (disposing)
+            _activeUiFragment?.Dispose();
+    }
+
+    protected CartridgeComponent? RetrieveCartridgeComponent(EntityUid? cartridgeUid)
+    {
+        return _entityManager?.GetComponentOrNull<CartridgeComponent>(cartridgeUid);
+    }
+
+    private void SendCartridgeUiReadyEvent(EntityUid cartridgeUid)
+    {
+        var message = new CartridgeLoaderUiMessage(cartridgeUid, CartridgeUiMessageAction.UIReady);
+        SendMessage(message);
+    }
+
+    private CartridgeUI? RetrieveCartridgeUI(EntityUid? cartridgeUid)
+    {
+        var component = _entityManager?.GetComponentOrNull<CartridgeUiComponent>(cartridgeUid);
+        component?.Ui?.Setup(this);
+        return component?.Ui;
+    }
+}