Add trigger-refactor components and systems: Batch 1 (#39391)

* Adds the following batch of trigger refactor components and their associated systems:

TriggerOnLand: LandEvent
TriggerOnExamined: ExaminedEvent
TriggerOnUnbuckle: UnbuckledEvent
TriggerOnBuckle: BuckledEvent
TriggerOnStrap: StrappedEvent
TriggerOnUnstrapped: UnstrappedEvent

* Removes unnecessary lines from comment

* Fix comment formatting, corrects grammar and increases comment clarity.

* adds last forgotten edit to comments

* Update Content.Shared/Trigger/Systems/TriggerOnStrappedOrBuckledSystem.cs

Removes unnecessary comments

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

Increases comment clarity

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

Increases comment clarity

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

Increases comment clarity

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

Increases comment clarity

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

Increases comment clarity

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

Increases comment clarity

Co-authored-by: slarticodefast <161409025+slarticodefast@users.noreply.github.com>
* refactored TriggerOnStrappedOrBuckledSystem.cs
removed TriggerOnExaminedSystem.cs and moved it into TriggerSystem.Interaction.cs

Changes currently untested, not sure how to make it so modders can change what method they want sending out the appropriate trigger key but want to save progress working on it and get feedback from maintainers

* Removed component which already exists as part of TriggerSystem.Interaction.cs

* Restores accidentally removed component

* Apply suggestions from code review

---------

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

diff --git a/Content.Shared/Trigger/Components/Triggers/TriggerOnBuckledComponent.cs b/Content.Shared/Trigger/Components/Triggers/TriggerOnBuckledComponent.cs
new file mode 100644 (file)
index 0000000..b6f3506
--- /dev/null
+++ b/Content.Shared/Trigger/Components/Triggers/TriggerOnBuckledComponent.cs
@@ -0,0 +1,11 @@
+using Robust.Shared.GameStates;
+
+namespace Content.Shared.Trigger.Components.Triggers;
+
+/// <summary>
+/// Triggers when the owning entity is buckled.
+/// This is intended to be used on buckle-able entities like mobs.
+/// The user is the strap entity (a chair or similar).
+/// </summary>
+[RegisterComponent, NetworkedComponent, AutoGenerateComponentState]
+public sealed partial class TriggerOnBuckledComponent : BaseTriggerOnXComponent;

diff --git a/Content.Shared/Trigger/Components/Triggers/TriggerOnExaminedComponent.cs b/Content.Shared/Trigger/Components/Triggers/TriggerOnExaminedComponent.cs
new file mode 100644 (file)
index 0000000..8ceb755
--- /dev/null
+++ b/Content.Shared/Trigger/Components/Triggers/TriggerOnExaminedComponent.cs
@@ -0,0 +1,10 @@
+using Robust.Shared.GameStates;
+
+namespace Content.Shared.Trigger.Components.Triggers;
+
+/// <summary>
+/// Triggers when the entity is being examined.
+/// The user is the player doing the examination.
+/// </summary>
+[RegisterComponent, NetworkedComponent, AutoGenerateComponentState]
+public sealed partial class TriggerOnExaminedComponent : BaseTriggerOnXComponent;

diff --git a/Content.Shared/Trigger/Components/Triggers/TriggerOnLandComponent.cs b/Content.Shared/Trigger/Components/Triggers/TriggerOnLandComponent.cs
new file mode 100644 (file)
index 0000000..48d0488
--- /dev/null
+++ b/Content.Shared/Trigger/Components/Triggers/TriggerOnLandComponent.cs
@@ -0,0 +1,10 @@
+using Robust.Shared.GameStates;
+
+namespace Content.Shared.Trigger.Components.Triggers;
+
+/// <summary>
+/// Triggers when the entity exits a floating or thrown state and lands on a surface.
+/// The user is the thrower.
+/// </summary>
+[RegisterComponent, NetworkedComponent, AutoGenerateComponentState]
+public sealed partial class TriggerOnLandComponent : BaseTriggerOnXComponent;

diff --git a/Content.Shared/Trigger/Components/Triggers/TriggerOnStrappedComponent.cs b/Content.Shared/Trigger/Components/Triggers/TriggerOnStrappedComponent.cs
new file mode 100644 (file)
index 0000000..b5a60b6
--- /dev/null
+++ b/Content.Shared/Trigger/Components/Triggers/TriggerOnStrappedComponent.cs
@@ -0,0 +1,11 @@
+using Robust.Shared.GameStates;
+
+namespace Content.Shared.Trigger.Components.Triggers;
+
+/// <summary>
+/// Triggers when something is strapped to the entity.
+/// This is intended to be used on objects like chairs or beds.
+/// The user is the entity strapped to the component owner.
+/// </summary>
+[RegisterComponent, NetworkedComponent, AutoGenerateComponentState]
+public sealed partial class TriggerOnStrappedComponent : BaseTriggerOnXComponent;

diff --git a/Content.Shared/Trigger/Components/Triggers/TriggerOnUnbuckledComponent.cs b/Content.Shared/Trigger/Components/Triggers/TriggerOnUnbuckledComponent.cs
new file mode 100644 (file)
index 0000000..47092f4
--- /dev/null
+++ b/Content.Shared/Trigger/Components/Triggers/TriggerOnUnbuckledComponent.cs
@@ -0,0 +1,11 @@
+using Robust.Shared.GameStates;
+
+namespace Content.Shared.Trigger.Components.Triggers;
+
+/// <summary>
+/// Triggers when the owning entity is unbuckled.
+/// This is intended to be used on buckle-able entities like mobs.
+/// The user is the strap entity (a chair or similar).
+/// </summary>
+[RegisterComponent, NetworkedComponent, AutoGenerateComponentState]
+public sealed partial class TriggerOnUnbuckledComponent : BaseTriggerOnXComponent;

diff --git a/Content.Shared/Trigger/Components/Triggers/TriggerOnUnstrappedComponent.cs b/Content.Shared/Trigger/Components/Triggers/TriggerOnUnstrappedComponent.cs
new file mode 100644 (file)
index 0000000..c9ff412
--- /dev/null
+++ b/Content.Shared/Trigger/Components/Triggers/TriggerOnUnstrappedComponent.cs
@@ -0,0 +1,11 @@
+using Robust.Shared.GameStates;
+
+namespace Content.Shared.Trigger.Components.Triggers;
+
+/// <summary>
+/// Triggers when something is unstrapped from the entity.
+/// This is intended to be used on objects like chairs or beds.
+/// The user is the entity unstrapped from the component owner.
+/// </summary>
+[RegisterComponent, NetworkedComponent, AutoGenerateComponentState]
+public sealed partial class TriggerOnUnstrappedComponent : BaseTriggerOnXComponent;

diff --git a/Content.Shared/Trigger/Systems/TriggerOnLandSystem.cs b/Content.Shared/Trigger/Systems/TriggerOnLandSystem.cs
new file mode 100644 (file)
index 0000000..754f285
--- /dev/null
+++ b/Content.Shared/Trigger/Systems/TriggerOnLandSystem.cs
@@ -0,0 +1,21 @@
+using Content.Shared.Throwing;
+using Content.Shared.Trigger.Components.Triggers;
+
+namespace Content.Shared.Trigger.Systems;
+
+public sealed partial class TriggerOnLandSystem : EntitySystem
+{
+    [Dependency] private readonly TriggerSystem _trigger = default!;
+
+    public override void Initialize()
+    {
+        base.Initialize();
+
+        SubscribeLocalEvent<TriggerOnLandComponent, LandEvent>(OnLand);
+    }
+
+    private void OnLand(Entity<TriggerOnLandComponent> ent, ref LandEvent args)
+    {
+        _trigger.Trigger(ent.Owner, args.User, ent.Comp.KeyOut);
+    }
+}

diff --git a/Content.Shared/Trigger/Systems/TriggerOnStrappedOrBuckledSystem.cs b/Content.Shared/Trigger/Systems/TriggerOnStrappedOrBuckledSystem.cs
new file mode 100644 (file)
index 0000000..d4960ff
--- /dev/null
+++ b/Content.Shared/Trigger/Systems/TriggerOnStrappedOrBuckledSystem.cs
@@ -0,0 +1,49 @@
+using Content.Shared.Buckle.Components;
+using Content.Shared.Trigger.Components.Triggers;
+
+namespace Content.Shared.Trigger.Systems;
+
+/// <summary>
+/// This is a system covering all trigger interactions involving strapping or buckling objects.
+/// The users of strap components are the objects having an entity strapped to them (IE: Chairs)
+/// The users of buckle components are entities being buckled to an object. (IE: Mobs and players)
+/// </summary>
+public sealed partial class TriggerOnStrappedOrBuckledSystem : EntitySystem
+{
+    [Dependency] private readonly TriggerSystem _trigger = default!;
+
+    public override void Initialize()
+    {
+        base.Initialize();
+
+        SubscribeLocalEvent<TriggerOnStrappedComponent, StrappedEvent>(OnStrapped);
+        SubscribeLocalEvent<TriggerOnUnstrappedComponent, UnstrappedEvent>(OnUnstrapped);
+        SubscribeLocalEvent<TriggerOnBuckledComponent, BuckledEvent>(OnBuckled);
+        SubscribeLocalEvent<TriggerOnUnbuckledComponent, UnbuckledEvent>(OnUnbuckled);
+    }
+
+
+    #region Class Methods
+    // Called by objects entities can be buckled to. (Chairs, surgical tables/)
+    private void OnStrapped(Entity<TriggerOnStrappedComponent> ent, ref StrappedEvent args)
+    {
+        _trigger.Trigger(ent.Owner, args.Strap, ent.Comp.KeyOut);
+    }
+
+    private void OnUnstrapped(Entity<TriggerOnUnstrappedComponent> ent, ref UnstrappedEvent args)
+    {
+        _trigger.Trigger(ent.Owner, args.Strap, ent.Comp.KeyOut);
+    }
+
+    // Called by entities that are buckled to an object. (Mobs, players.)
+    private void OnBuckled(Entity<TriggerOnBuckledComponent> ent, ref BuckledEvent args)
+    {
+        _trigger.Trigger(ent.Owner, args.Buckle, ent.Comp.KeyOut);
+    }
+
+    private void OnUnbuckled(Entity<TriggerOnUnbuckledComponent> ent, ref UnbuckledEvent args)
+    {
+        _trigger.Trigger(ent.Owner, args.Buckle, ent.Comp.KeyOut);
+    }
+    #endregion
+}

diff --git a/Content.Shared/Trigger/Systems/TriggerSystem.Interaction.cs b/Content.Shared/Trigger/Systems/TriggerSystem.Interaction.cs
index 035ef4ec9119363f7da5a7c4e0b6fa9430148faa..230b628663e7b968fee244e99588863f230a5629 100644 (file)
--- a/Content.Shared/Trigger/Systems/TriggerSystem.Interaction.cs
+++ b/Content.Shared/Trigger/Systems/TriggerSystem.Interaction.cs
@@ -1,4 +1,5 @@
-using Content.Shared.Interaction;
+using Content.Shared.Examine;
+using Content.Shared.Interaction;
 using Content.Shared.Interaction.Events;
 using Content.Shared.Item.ItemToggle.Components;
 using Content.Shared.Trigger.Components.Triggers;
@@ -10,6 +11,8 @@ public sealed partial class TriggerSystem
 {
     private void InitializeInteraction()
     {
+        SubscribeLocalEvent<TriggerOnExaminedComponent, ExaminedEvent>(OnExamined);
+
         SubscribeLocalEvent<TriggerOnActivateComponent, ActivateInWorldEvent>(OnActivate);
         SubscribeLocalEvent<TriggerOnUseComponent, UseInHandEvent>(OnUse);
         SubscribeLocalEvent<TriggerOnInteractHandComponent, InteractHandEvent>(OnInteractHand);
@@ -19,6 +22,11 @@ public sealed partial class TriggerSystem
         SubscribeLocalEvent<UseDelayOnTriggerComponent, TriggerEvent>(HandleUseDelayOnTrigger);
     }
 
+    private void OnExamined(Entity<TriggerOnExaminedComponent> ent, ref ExaminedEvent args)
+    {
+        Trigger(ent.Owner, args.Examiner, ent.Comp.KeyOut);
+    }
+
     private void OnActivate(Entity<TriggerOnActivateComponent> ent, ref ActivateInWorldEvent args)
     {
         if (args.Handled)