Landmine stepoff (space-wizards#22962)

* make landmine work on stepping off

* update methods naming

* made both step modes possible

* updated stepoff event raise to not interfere with game physics internals

* added comments

* figuring out how audiosystem works

* added beep sound effect, updated how stepoff trigger works to make it more consistent

* updated source in attributions.yml

* made stepoff working every time

* introduced suggested changes

* updated janitor's WetSignMine to have audio

* made cleaner events and bashing my head at OnEndCollide event raise

* inverted conditional where applicable

* review

---------

Co-authored-by: Yurii Kis <[email protected]>
Co-authored-by: metalgearsloth <[email protected]>

Content.Server/Ensnaring/EnsnareableSystem.Ensnaring.cs

@@ -25,7 +25,7 @@ public void InitializeEnsnaring()
     {
         SubscribeLocalEvent<EnsnaringComponent, ComponentRemove>(OnComponentRemove);
         SubscribeLocalEvent<EnsnaringComponent, StepTriggerAttemptEvent>(AttemptStepTrigger);
-        SubscribeLocalEvent<EnsnaringComponent, StepTriggeredEvent>(OnStepTrigger);
+        SubscribeLocalEvent<EnsnaringComponent, StepTriggeredOffEvent>(OnStepTrigger);
         SubscribeLocalEvent<EnsnaringComponent, ThrowDoHitEvent>(OnThrowHit);
         SubscribeLocalEvent<EnsnaringComponent, AttemptPacifiedThrowEvent>(OnAttemptPacifiedThrow);
     }
@@ -49,7 +49,7 @@ private void AttemptStepTrigger(EntityUid uid, EnsnaringComponent component, ref
         args.Continue = true;
     }
 
-    private void OnStepTrigger(EntityUid uid, EnsnaringComponent component, ref StepTriggeredEvent args)
+    private void OnStepTrigger(EntityUid uid, EnsnaringComponent component, ref StepTriggeredOffEvent args)
     {
         TryEnsnare(args.Tripper, uid, component);
     }

Content.Server/Explosion/EntitySystems/TriggerSystem.cs

@@ -88,7 +88,7 @@ public override void Initialize()
             SubscribeLocalEvent<TriggerOnCollideComponent, StartCollideEvent>(OnTriggerCollide);
             SubscribeLocalEvent<TriggerOnActivateComponent, ActivateInWorldEvent>(OnActivate);
             SubscribeLocalEvent<TriggerImplantActionComponent, ActivateImplantEvent>(OnImplantTrigger);
-            SubscribeLocalEvent<TriggerOnStepTriggerComponent, StepTriggeredEvent>(OnStepTriggered);
+            SubscribeLocalEvent<TriggerOnStepTriggerComponent, StepTriggeredOffEvent>(OnStepTriggered);
             SubscribeLocalEvent<TriggerOnSlipComponent, SlipEvent>(OnSlipTriggered);
             SubscribeLocalEvent<TriggerWhenEmptyComponent, OnEmptyGunShotEvent>(OnEmptyTriggered);
 
@@ -228,7 +228,7 @@ private void OnImplantTrigger(EntityUid uid, TriggerImplantActionComponent compo
             args.Handled = Trigger(uid);
         }
 
-        private void OnStepTriggered(EntityUid uid, TriggerOnStepTriggerComponent component, ref StepTriggeredEvent args)
+        private void OnStepTriggered(EntityUid uid, TriggerOnStepTriggerComponent component, ref StepTriggeredOffEvent args)
         {
             Trigger(uid, args.Tripper);
         }

Content.Server/LandMines/LandMineComponent.cs

@@ -1,6 +1,13 @@
-namespace Content.Server.LandMines;
+using Robust.Shared.Audio;
+
+namespace Content.Server.LandMines;
 
 [RegisterComponent]
 public sealed partial class LandMineComponent : Component
 {
+    /// <summary>
+    /// Trigger sound effect when stepping onto landmine
+    /// </summary>
+    [DataField, ViewVariables(VVAccess.ReadWrite)]
+    public SoundSpecifier? Sound;
 }

Content.Server/LandMines/LandMineSystem.cs

@@ -1,43 +1,43 @@
-using Content.Server.Explosion.EntitySystems;
+using Content.Server.Explosion.EntitySystems;
 using Content.Shared.Popups;
-using Content.Shared.StepTrigger;
 using Content.Shared.StepTrigger.Systems;
-using Robust.Shared.Player;
+using Robust.Shared.Audio;
+using Robust.Shared.Audio.Systems;
 
 namespace Content.Server.LandMines;
 
 public sealed class LandMineSystem : EntitySystem
 {
+    [Dependency] private readonly SharedAudioSystem _audioSystem = default!;
     [Dependency] private readonly SharedPopupSystem _popupSystem = default!;
     [Dependency] private readonly TriggerSystem _trigger = default!;
 
-
     public override void Initialize()
     {
-        SubscribeLocalEvent<LandMineComponent, StepTriggeredEvent>(HandleTriggered);
-        SubscribeLocalEvent<LandMineComponent, StepTriggerAttemptEvent>(HandleTriggerAttempt);
+        SubscribeLocalEvent<LandMineComponent, StepTriggeredOnEvent>(HandleStepOnTriggered);
+        SubscribeLocalEvent<LandMineComponent, StepTriggeredOffEvent>(HandleStepOffTriggered);
+
+        SubscribeLocalEvent<LandMineComponent, StepTriggerAttemptEvent>(HandleStepTriggerAttempt);
     }
 
-    private static void HandleTriggerAttempt(
-        EntityUid uid,
-        LandMineComponent component,
-        ref StepTriggerAttemptEvent args)
+    private void HandleStepOnTriggered(EntityUid uid, LandMineComponent component, ref StepTriggeredOnEvent args)
     {
-        args.Continue = true;
+        _popupSystem.PopupCoordinates(
+            Loc.GetString("land-mine-triggered", ("mine", uid)),
+            Transform(uid).Coordinates,
+            args.Tripper,
+            PopupType.LargeCaution);
+
+        _audioSystem.PlayPvs(component.Sound, uid);
     }
 
-    private void HandleTriggered(EntityUid uid, LandMineComponent component, ref StepTriggeredEvent args)
+    private void HandleStepOffTriggered(EntityUid uid, LandMineComponent component, ref StepTriggeredOffEvent args)
     {
-        // This doesn't use TriggerOnStepTrigger since we don't want to display the popup if nothing happens
-        // and I didn't feel like making an `AfterTrigger` event
-        if (_trigger.Trigger(uid, args.Tripper))
-        {
-            _popupSystem.PopupCoordinates(
-                Loc.GetString("land-mine-triggered", ("mine", uid)),
-                Transform(uid).Coordinates,
-                args.Tripper,
-                PopupType.LargeCaution);
-        }
+        _trigger.Trigger(uid, args.Tripper);
     }
-}
 
+    private static void HandleStepTriggerAttempt(EntityUid uid, LandMineComponent component, ref StepTriggerAttemptEvent args)
+    {
+        args.Continue = true;
+    }
+}

Content.Server/Tiles/LavaSystem.cs

@@ -11,7 +11,7 @@ public sealed class LavaSystem : EntitySystem
     public override void Initialize()
     {
         base.Initialize();
-        SubscribeLocalEvent<LavaComponent, StepTriggeredEvent>(OnLavaStepTriggered);
+        SubscribeLocalEvent<LavaComponent, StepTriggeredOffEvent>(OnLavaStepTriggered);
         SubscribeLocalEvent<LavaComponent, StepTriggerAttemptEvent>(OnLavaStepTriggerAttempt);
     }
 
@@ -23,7 +23,7 @@ private void OnLavaStepTriggerAttempt(EntityUid uid, LavaComponent component, re
         args.Continue = true;
     }
 
-    private void OnLavaStepTriggered(EntityUid uid, LavaComponent component, ref StepTriggeredEvent args)
+    private void OnLavaStepTriggered(EntityUid uid, LavaComponent component, ref StepTriggeredOffEvent args)
     {
         var otherUid = args.Tripper;
 

Content.Shared/Chasm/ChasmSystem.cs

@@ -24,7 +24,7 @@ public override void Initialize()
     {
         base.Initialize();
 
-        SubscribeLocalEvent<ChasmComponent, StepTriggeredEvent>(OnStepTriggered);
+        SubscribeLocalEvent<ChasmComponent, StepTriggeredOffEvent>(OnStepTriggered);
         SubscribeLocalEvent<ChasmComponent, StepTriggerAttemptEvent>(OnStepTriggerAttempt);
         SubscribeLocalEvent<ChasmFallingComponent, UpdateCanMoveEvent>(OnUpdateCanMove);
     }
@@ -47,7 +47,7 @@ public override void Update(float frameTime)
         }
     }
 
-    private void OnStepTriggered(EntityUid uid, ChasmComponent component, ref StepTriggeredEvent args)
+    private void OnStepTriggered(EntityUid uid, ChasmComponent component, ref StepTriggeredOffEvent args)
     {
         // already doomed
         if (HasComp<ChasmFallingComponent>(args.Tripper))

Content.Shared/Slippery/SlipperySystem.cs

@@ -31,14 +31,14 @@ public override void Initialize()
         base.Initialize();
 
         SubscribeLocalEvent<SlipperyComponent, StepTriggerAttemptEvent>(HandleAttemptCollide);
-        SubscribeLocalEvent<SlipperyComponent, StepTriggeredEvent>(HandleStepTrigger);
+        SubscribeLocalEvent<SlipperyComponent, StepTriggeredOffEvent>(HandleStepTrigger);
         SubscribeLocalEvent<NoSlipComponent, SlipAttemptEvent>(OnNoSlipAttempt);
         SubscribeLocalEvent<ThrownItemComponent, SlipCausingAttemptEvent>(OnThrownSlipAttempt);
         // as long as slip-resistant mice are never added, this should be fine (otherwise a mouse-hat will transfer it's power to the wearer).
         SubscribeLocalEvent<NoSlipComponent, InventoryRelayedEvent<SlipAttemptEvent>>((e, c, ev) => OnNoSlipAttempt(e, c, ev.Args));
     }
 
-    private void HandleStepTrigger(EntityUid uid, SlipperyComponent component, ref StepTriggeredEvent args)
+    private void HandleStepTrigger(EntityUid uid, SlipperyComponent component, ref StepTriggeredOffEvent args)
     {
         TrySlip(uid, component, args.Tripper);
     }

Content.Shared/StepTrigger/Components/StepTriggerComponent.cs

@@ -49,8 +49,14 @@ public sealed partial class StepTriggerComponent : Component
     ///     If this is true, steptrigger will still occur on entities that are in air / weightless. They do not
     ///     by default.
     /// </summary>
-    [DataField]
+    [DataField, AutoNetworkedField]
     public bool IgnoreWeightless;
+
+    /// <summary>
+    /// Does this have separate "StepOn" and "StepOff" triggers.
+    /// </summary>
+    [DataField, AutoNetworkedField]
+    public bool StepOn = false;
 }
 
 [RegisterComponent]

Content.Shared/StepTrigger/Systems/StepTriggerSystem.cs

@@ -11,6 +11,7 @@ public sealed class StepTriggerSystem : EntitySystem
 {
     [Dependency] private readonly EntityLookupSystem _entityLookup = default!;
     [Dependency] private readonly SharedGravitySystem _gravity = default!;
+    [Dependency] private readonly SharedMapSystem _map = default!;
 
     public override void Initialize()
     {
@@ -40,7 +41,9 @@ public override void Update(float frameTime)
         while (enumerator.MoveNext(out var uid, out var active, out var trigger, out var transform))
         {
             if (!Update(uid, trigger, transform, query))
+            {
                 continue;
+            }
 
             RemCompDeferred(uid, active);
         }
@@ -56,7 +59,8 @@ private bool Update(EntityUid uid, StepTriggerComponent component, TransformComp
 
         if (component.Blacklist != null && TryComp<MapGridComponent>(transform.GridUid, out var grid))
         {
-            var anch = grid.GetAnchoredEntitiesEnumerator(grid.LocalToTile(transform.Coordinates));
+            var positon = _map.LocalToTile(uid, grid, transform.Coordinates);
+            var anch = _map.GetAnchoredEntitiesEnumerator(uid, grid, positon);
 
             while (anch.MoveNext(out var ent))
             {
@@ -109,8 +113,16 @@ private void UpdateColliding(EntityUid uid, StepTriggerComponent component, Tran
             return;
         }
 
-        var ev = new StepTriggeredEvent { Source = uid, Tripper = otherUid };
-        RaiseLocalEvent(uid, ref ev, true);
+        if (component.StepOn)
+        {
+            var evStep = new StepTriggeredOnEvent(uid, otherUid);
+            RaiseLocalEvent(uid, ref evStep);
+        }
+        else
+        {
+            var evStep = new StepTriggeredOffEvent(uid, otherUid);
+            RaiseLocalEvent(uid, ref evStep);
+        }
 
         component.CurrentlySteppedOn.Add(otherUid);
         Dirty(uid, component);
@@ -130,7 +142,7 @@ private bool CanTrigger(EntityUid uid, EntityUid otherUid, StepTriggerComponent
 
         var msg = new StepTriggerAttemptEvent { Source = uid, Tripper = otherUid };
 
-        RaiseLocalEvent(uid, ref msg, true);
+        RaiseLocalEvent(uid, ref msg);
 
         return msg.Continue && !msg.Cancelled;
     }
@@ -163,6 +175,12 @@ private void OnEndCollide(EntityUid uid, StepTriggerComponent component, ref End
         component.CurrentlySteppedOn.Remove(otherUid);
         Dirty(uid, component);
 
+        if (component.StepOn)
+        {
+            var evStepOff = new StepTriggeredOffEvent(uid, otherUid);
+            RaiseLocalEvent(uid, ref evStepOff);
+        }
+
         if (component.Colliding.Count == 0)
         {
             RemCompDeferred<StepTriggerActiveComponent>(uid);
@@ -230,9 +248,14 @@ public struct StepTriggerAttemptEvent
     public bool Cancelled;
 }
 
+/// <summary>
+/// Raised when an entity stands on a steptrigger initially (assuming it has both on and off states).
+/// </summary>
 [ByRefEvent]
-public struct StepTriggeredEvent
-{
-    public EntityUid Source;
-    public EntityUid Tripper;
-}
+public readonly record struct StepTriggeredOnEvent(EntityUid Source, EntityUid Tripper);
+
+/// <summary>
+/// Raised when an entity leaves a steptrigger if it has on and off states OR when an entity intersects a steptrigger.
+/// </summary>
+[ByRefEvent]
+public readonly record struct StepTriggeredOffEvent(EntityUid Source, EntityUid Tripper);

Resources/Audio/Effects/attributions.yml

@@ -221,3 +221,8 @@
   copyright: TGStation at 3df5d3b42bfb6b3b5adba1067ab41f83816255bb
   license: CC-BY-SA-3.0
   source: https://github.com/tgstation/tgstation/blob/3df5d3b42bfb6b3b5adba1067ab41f83816255bb/sound/misc/server-ready.ogg
+
+- files: [beep_landmine.ogg]
+  copyright: '"beep_landmine.ogg" by kaktuscsc of Discord for SS14'
+  license: "CC-BY-SA-3.0"
+  source: https://github.com/YuriyKiss/space-station-14/commit/971a135a9c83aed46e967aac9302ab5b35562b5f

Resources/Prototypes/Entities/Objects/Misc/land_mine.yml

@@ -35,9 +35,13 @@
       - !type:DoActsBehavior
         acts: [ "Destruction" ]
   - type: LandMine
-  - type: TriggerOnStepTrigger
+    sound:
+        path: /Audio/Effects/beep_landmine.ogg
+        params:
+            maxDistance: 10
   - type: StepTrigger
     requiredTriggeredSpeed: 0
+    stepOn: true
 
 - type: entity
   name: kick mine
@@ -57,7 +61,6 @@
   - type: Construction
     graph: ModularMineGraph
     node: emptyCase
-  - type: LandMine
 
 - type: entity
   name: explosive mine
@@ -71,4 +74,3 @@
     intensitySlope: 3
     totalIntensity: 120 # about a ~4 tile radius
     canCreateVacuum: false
-  - type: DeleteOnTrigger

Resources/Prototypes/Entities/Objects/Specific/Janitorial/janitor.yml

@@ -230,6 +230,7 @@
   - type: StepTrigger
     intersectRatio: 0.2
     requiredTriggeredSpeed: 0
+    stepOn: true
   - type: CollisionWake
     enabled: false
   - type: Physics
@@ -251,6 +252,10 @@
         mask:
         - ItemMask
   - type: LandMine
+    sound:
+      path: /Audio/Effects/beep_landmine.ogg
+      params:
+        maxDistance: 10
   - type: ExplodeOnTrigger
   - type: Explosive
     explosionType: HardBomb  # normally Default and max 5 total 60