TriggerOnUiOpen/Close (#41718)

* feat: TriggerOnUiOpen/Close

* chore: minor clarification

* Update Content.Shared/Trigger/Components/Triggers/TriggerOnUiCloseComponent.cs

Co-authored-by: slarticodefast <161409025+slarticodefast@users.noreply.github.com>
* Update Content.Shared/Trigger/Components/Triggers/TriggerOnUiOpenComponent.cs

Co-authored-by: slarticodefast <161409025+slarticodefast@users.noreply.github.com>
* chore: review

---------

Co-authored-by: slarticodefast <161409025+slarticodefast@users.noreply.github.com>

diff --git a/Content.Shared/Trigger/Components/Triggers/TriggerOnUiCloseComponent.cs b/Content.Shared/Trigger/Components/Triggers/TriggerOnUiCloseComponent.cs
new file mode 100644 (file)
index 0000000..695f296
--- /dev/null
+++ b/Content.Shared/Trigger/Components/Triggers/TriggerOnUiCloseComponent.cs
@@ -0,0 +1,18 @@
+using Robust.Shared.GameStates;
+
+namespace Content.Shared.Trigger.Components.Triggers;
+
+/// <summary>
+/// Triggers when a user closes a UI belonging to the owning entity.
+/// The user is the actor that tries to open a UI.
+/// </summary>
+[RegisterComponent, NetworkedComponent, AutoGenerateComponentState]
+public sealed partial class TriggerOnUiCloseComponent : BaseTriggerOnXComponent
+{
+    /// <summary>
+    /// If it should only work on specific UIs.
+    /// Null means it will work on any UI key.
+    /// </summary>
+    [DataField, AutoNetworkedField]
+    public HashSet<Enum>? UiKeys;
+}

diff --git a/Content.Shared/Trigger/Components/Triggers/TriggerOnUiOpenComponent.cs b/Content.Shared/Trigger/Components/Triggers/TriggerOnUiOpenComponent.cs
new file mode 100644 (file)
index 0000000..bf83b7e
--- /dev/null
+++ b/Content.Shared/Trigger/Components/Triggers/TriggerOnUiOpenComponent.cs
@@ -0,0 +1,18 @@
+using Robust.Shared.GameStates;
+
+namespace Content.Shared.Trigger.Components.Triggers;
+
+/// <summary>
+/// Triggers when a user opens a UI belonging to the owning entity.
+/// The user is the actor that tries to open a UI.
+/// </summary>
+[RegisterComponent, NetworkedComponent, AutoGenerateComponentState]
+public sealed partial class TriggerOnUiOpenComponent : BaseTriggerOnXComponent
+{
+    /// <summary>
+    /// If it should only work on specific UIs.
+    /// Null means it will work on any UI key.
+    /// </summary>
+    [DataField, AutoNetworkedField]
+    public HashSet<Enum>? UiKeys;
+}

diff --git a/Content.Shared/Trigger/Systems/TriggerSystem.Interaction.cs b/Content.Shared/Trigger/Systems/TriggerSystem.Interaction.cs
index 62f483e876392cc2684c26cc3ad32295b8dd5b6d..944239ccf8e1d28b8fb35bdd73a0fdb9b62d04ad 100644 (file)
--- a/Content.Shared/Trigger/Systems/TriggerSystem.Interaction.cs
+++ b/Content.Shared/Trigger/Systems/TriggerSystem.Interaction.cs
@@ -21,6 +21,9 @@ public sealed partial class TriggerSystem
         SubscribeLocalEvent<TriggerOnThrowComponent, ThrowEvent>(OnThrow);
         SubscribeLocalEvent<TriggerOnThrownComponent, ThrownEvent>(OnThrown);
 
+        SubscribeLocalEvent<TriggerOnUiOpenComponent, BoundUIOpenedEvent>(OnUiOpened);
+        SubscribeLocalEvent<TriggerOnUiCloseComponent, BoundUIClosedEvent>(OnUiClosed);
+
         SubscribeLocalEvent<ItemToggleOnTriggerComponent, TriggerEvent>(HandleItemToggleOnTrigger);
         SubscribeLocalEvent<AnchorOnTriggerComponent, TriggerEvent>(HandleAnchorOnTrigger);
         SubscribeLocalEvent<UseDelayOnTriggerComponent, TriggerEvent>(HandleUseDelayOnTrigger);
@@ -83,6 +86,22 @@ public sealed partial class TriggerSystem
         Trigger(ent.Owner, args.User, ent.Comp.KeyOut);
     }
 
+    private void OnUiOpened(Entity<TriggerOnUiOpenComponent> ent, ref BoundUIOpenedEvent args)
+    {
+        if (ent.Comp.UiKeys == null || ent.Comp.UiKeys.Contains(args.UiKey))
+        {
+            Trigger(ent, args.Actor, ent.Comp.KeyOut);
+        }
+    }
+
+    private void OnUiClosed(Entity<TriggerOnUiCloseComponent> ent, ref BoundUIClosedEvent args)
+    {
+        if (ent.Comp.UiKeys == null || ent.Comp.UiKeys.Contains(args.UiKey))
+        {
+            Trigger(ent, args.Actor, ent.Comp.KeyOut);
+        }
+    }
+
     private void HandleItemToggleOnTrigger(Entity<ItemToggleOnTriggerComponent> ent, ref TriggerEvent args)
     {
         if (args.Key != null && !ent.Comp.KeysIn.Contains(args.Key))