[Port] StepTriggerGroup From WhiteDream (#929)

# Description This is a port of WWhiteDreamProject/wwdpublic#53 from White Dream. This PR improves the StepTriggerImmune component by making it operate on a more granular Blacklist system, such that StepTriggerImmune entities can further clarify via prototypes which kinds of floor traps they are immune to, such as landmines/mousetraps, and not have blanket immunity to everything. Because it turns out things like Lava and Soap also were caught by the immunity, when really we just wanted Harpies & Felinids to not trigger landmines. <details><summary><h1>Media</h1></summary> <p> > # Описание > Необходимо настроить модификатор урона, чтобы IPC не получали урон от осколков стекла. > > Иммунитет StepTriggerImmuneComponent доработан. Теперь имеются несколько типов (types): Lava - тип тайла, наступив на который появляется урон. Это собственно лава и LiquidPlasma Landmine - мины. Chasm - дырка в карте, куда можно провалиться Mousetrap - Мышеловка SlipTile - Все, что должно подскальзывать игроков, имеющее размер тайла SlipEntity - Все, что должно подскальзывать игроков, имеющее развер энтити. Разделено для баланса. Самые ловки могут игнорировать мелкие предметы (энтити), т.е. уворачиваться от них. Но большие по площади вещи (тайлы по типу разлитой воды, бананиума) просчитываются отдельно. > > # Изменения > * [x] Улучшить StepTriggerSystem (Immune) > * [x] Добавлены типы триггера. - Lava Landmine Shard Chasm Mousetrap SlipTile SlipEntity > * [x] Исправить осколки у IPC > * [x] Исправить отсутствие урона от лавы и падение в дыры у фелинидов и гарпий. > > 🆑 Hell_Cat > > * Feature: StepTriggerSystem is improved | Улучшена StepTriggerSystem > * fix: IPC: Immunity for shards and SpiderWeb | Иммунитет осколкам. > * fix: Felinid | Фелиниды : Immunity for Shard Landmine Mousetrap SlipEntities | Иммунитет для осколков, жидкости, мин, мышеловок, мыла и бананов. > * fix: Harpy | Гарпия : Immunity for Shards Landmine Mousetrap | Иммунитет для осколков, жидкости, мин и мышеловок. > * fix: Mice | Мыши : Don't blow up on landmines | Мыши не подрываются на минах. </p> </details> # Changelog :cl: Hell_Cat Feature: StepTriggerSystem has been improved with new StepTriggerGroups. Additionally, the StepTriggerImmune component now allows declaring for specific StepTriggerGroups for a given entity to be immune to. Some examples may be, Felinids, Mice, and Harpies being unable to set off Landmines. --------- Signed-off-by: VMSolidus <[email protected]> Co-authored-by: Ivan <[email protected]> Co-authored-by: FoxxoTrystan <[email protected]>
Simple-Station · Sep 19, 2024 · dee5a40 · dee5a40
1 parent d6dd2ea
commit dee5a40
Show file tree

Hide file tree

Showing 27 changed files with 218 additions and 12 deletions.
diff --git a/Content.Shared/StepTrigger/Components/StepTriggerComponent.cs b/Content.Shared/StepTrigger/Components/StepTriggerComponent.cs
@@ -1,3 +1,4 @@
+using Content.Shared.StepTrigger.Prototypes;
 using Content.Shared.StepTrigger.Systems;
 using Content.Shared.Whitelist;
 using Robust.Shared.GameStates;
@@ -53,15 +54,18 @@ public sealed partial class StepTriggerComponent : Component
     public bool IgnoreWeightless;
 
     /// <summary>
-    /// Does this have separate "StepOn" and "StepOff" triggers.
+    ///     Does this have separate "StepOn" and "StepOff" triggers.
     /// </summary>
     [DataField, AutoNetworkedField]
     public bool StepOn = false;
+
+    /// <summary>
+    ///     If TriggerGroups is specified, it will check StepTriggerImmunityComponent to have the same TriggerType to activate immunity
+    /// </summary>
+    [DataField]
+    public StepTriggerGroup? TriggerGroups;
 }
 
 [RegisterComponent]
 [Access(typeof(StepTriggerSystem))]
-public sealed partial class StepTriggerActiveComponent : Component
-{
-
-}
+public sealed partial class StepTriggerActiveComponent : Component { }
diff --git a/Content.Shared/StepTrigger/Components/StepTriggerImmuneComponent.cs b/Content.Shared/StepTrigger/Components/StepTriggerImmuneComponent.cs
@@ -1,3 +1,5 @@
+using Content.Shared.StepTrigger.Prototypes;
+using Content.Shared.StepTrigger.Systems;
 using Robust.Shared.GameStates;
 
 namespace Content.Shared.StepTrigger.Components;
@@ -12,4 +14,12 @@ namespace Content.Shared.StepTrigger.Components;
 ///     Consider using a subscription to StepTriggerAttemptEvent if you wish to be more selective.
 /// </remarks>
 [RegisterComponent, NetworkedComponent]
-public sealed partial class StepTriggerImmuneComponent : Component { }
+[Access(typeof(StepTriggerSystem))]
+public sealed partial class StepTriggerImmuneComponent : Component
+{
+    /// <summary>
+    ///     WhiteList of immunity step triggers.
+    /// </summary>
+    [DataField]
+    public StepTriggerGroup? Whitelist;
+}
diff --git a/Content.Shared/StepTrigger/Prototypes/StepTriggerGroup.cs b/Content.Shared/StepTrigger/Prototypes/StepTriggerGroup.cs
@@ -0,0 +1,72 @@
+using Content.Shared.StepTrigger.Components;
+using Robust.Shared.Prototypes;
+using Robust.Shared.Serialization;
+
+namespace Content.Shared.StepTrigger.Prototypes;
+
+/// <summary>
+///     A group of <see cref="StepTriggerTypePrototype">
+///     Used to determine StepTriggerTypes like Tags.
+///     Used for better work with Immunity.
+///     StepTriggerTypes in StepTriggerTypes.yml
+/// </summary>
+/// <code>
+/// stepTriggerGroups:
+///   types:
+///   - Lava
+///   - Landmine
+///   - Shard
+///   - Chasm
+///   - Mousetrap
+///   - SlipTile
+///   - SlipEntity
+/// </code>
+[DataDefinition]
+[Serializable, NetSerializable]
+public sealed partial class StepTriggerGroup
+{
+    [DataField]
+    public List<ProtoId<StepTriggerTypePrototype>>? Types = null;
+
+    /// <summary>
+    ///     Checks if types of this StepTriggerGroup is similar to types of AnotherGroup
+    /// </summary>
+    public bool IsValid(StepTriggerGroup? anotherGroup)
+    {
+        if (Types is null)
+            return false;
+
+        foreach (var type in Types)
+        {
+            if (anotherGroup != null
+                && anotherGroup.Types != null
+                && anotherGroup.Types.Contains(type))
+                return true;
+        }
+        return false;
+    }
+
+    /// <summary>
+    ///     Checks validation (if types of this StepTriggerGroup are similar to types of
+    ///     another StepTriggerComponent.
+    /// </summary>
+    public bool IsValid(StepTriggerComponent component)
+    {
+        if (component.TriggerGroups is null)
+            return false;
+
+        return IsValid(component.TriggerGroups);
+    }
+
+    /// <summary>
+    ///     Checks validation (if types of this StepTriggerGroup are similar to types of
+    ///     another StepTriggerImmuneComponent.
+    /// </summary>
+    public bool IsValid(StepTriggerImmuneComponent component)
+    {
+        if (component.Whitelist is null)
+            return false;
+
+        return IsValid(component.Whitelist);
+    }
+}
diff --git a/Content.Shared/StepTrigger/Prototypes/StepTriggerTypePrototype.cs b/Content.Shared/StepTrigger/Prototypes/StepTriggerTypePrototype.cs
@@ -0,0 +1,15 @@
+using Robust.Shared.Prototypes;
+
+namespace Content.Shared.StepTrigger.Prototypes;
+
+/// <summary>
+///     Prototype representing a StepTriggerType in YAML.
+///     Meant to only have an ID property, as that is the only thing that
+///     gets saved in StepTriggerGroup.
+/// </summary>
+[Prototype]
+public sealed partial class StepTriggerTypePrototype : IPrototype
+{
+    [ViewVariables, IdDataField]
+    public string ID { get; private set; } = default!;
+}
diff --git a/Content.Shared/StepTrigger/Systems/StepTriggerSystem.cs b/Content.Shared/StepTrigger/Systems/StepTriggerSystem.cs
@@ -118,11 +118,16 @@ private void UpdateColliding(EntityUid uid, StepTriggerComponent component, Tran
 
     private bool CanTrigger(EntityUid uid, EntityUid otherUid, StepTriggerComponent component)
     {
-        if (HasComp<StepTriggerImmuneComponent>(otherUid)
-            || !component.Active
+        if (!component.Active
             || component.CurrentlySteppedOn.Contains(otherUid))
             return false;
 
+        // Immunity checks
+        if (TryComp<StepTriggerImmuneComponent>(otherUid, out var stepTriggerImmuneComponent)
+            && component.TriggerGroups != null
+            && component.TriggerGroups.IsValid(stepTriggerImmuneComponent))
+            return false;
+
         // Can't trigger if we don't ignore weightless entities
         // and the entity is flying or currently weightless
         // Makes sense simulation wise to have this be part of steptrigger directly IMO

diff --git a/Resources/Prototypes/Entities/Effects/chemistry_effects.yml b/Resources/Prototypes/Entities/Effects/chemistry_effects.yml
@@ -77,6 +77,9 @@
     animationState: foam-dissolve
   - type: Slippery
   - type: StepTrigger
+    triggerGroups:
+      types:
+      - SlipTile
   # disabled until foam reagent duplication is fixed
   #- type: ScoopableSolution
   #  solution: solutionArea
@@ -135,7 +138,7 @@
   - type: RCDDeconstructable
     cost: 2
     delay: 2
-    fx: EffectRCDDeconstruct2  
+    fx: EffectRCDDeconstruct2
   - type: Clickable
   - type: InteractionOutline
   - type: Sprite

diff --git a/Resources/Prototypes/Entities/Effects/puddle.yml b/Resources/Prototypes/Entities/Effects/puddle.yml
@@ -149,6 +149,9 @@
   - type: EdgeSpreader
     id: Puddle
   - type: StepTrigger
+    triggerGroups:
+      types:
+      - SlipTile
   - type: Drink
     delay: 3
     transferAmount: 1

diff --git a/Resources/Prototypes/Entities/Mobs/NPCs/animals.yml b/Resources/Prototypes/Entities/Mobs/NPCs/animals.yml
@@ -1689,6 +1689,10 @@
   - type: FireVisuals
     sprite: Mobs/Effects/onfire.rsi
     normalState: Mouse_burning
+  - type: StepTriggerImmune
+    whitelist:
+      types:
+      - Landmine
 
 - type: entity
   parent: MobMouse

diff --git a/Resources/Prototypes/Entities/Mobs/NPCs/silicon.yml b/Resources/Prototypes/Entities/Mobs/NPCs/silicon.yml
@@ -137,6 +137,9 @@
   - type: Speech
     speechVerb: Cluwne
   - type: StepTrigger
+    triggerGroups:
+      types:
+      - SlipEntity
     intersectRatio: 0.2
   - type: Fixtures
     fixtures:

diff --git a/Resources/Prototypes/Entities/Mobs/Player/ipc.yml b/Resources/Prototypes/Entities/Mobs/Player/ipc.yml
@@ -111,6 +111,10 @@
   - type: OfferItem
   - type: LayingDown
   - type: Carriable
+  - type: StepTriggerImmune
+    whitelist:
+      types:
+      - Shard
 
 - type: entity
   save: false

diff --git a/Resources/Prototypes/Entities/Mobs/Species/diona.yml b/Resources/Prototypes/Entities/Mobs/Species/diona.yml
@@ -114,6 +114,10 @@
     walkModifier: 0.75
   - type: SpeedModifierImmunity
   - type: NoSlip
+  - type: StepTriggerImmune
+    whitelist:
+      types:
+      - Shard
 
 - type: entity
   parent: BaseSpeciesDummy

diff --git a/Resources/Prototypes/Entities/Mobs/Species/harpy.yml b/Resources/Prototypes/Entities/Mobs/Species/harpy.yml
@@ -123,6 +123,11 @@
     - GalacticCommon
     - SolCommon
   - type: StepTriggerImmune
+    whitelist:
+      types:
+      - Shard
+      - Landmine
+      - Mousetrap
 
 - type: entity
   save: false

diff --git a/Resources/Prototypes/Entities/Objects/Consumable/Food/produce.yml b/Resources/Prototypes/Entities/Objects/Consumable/Food/produce.yml
@@ -314,6 +314,9 @@
     launchForwardsMultiplier: 1.5
   - type: StepTrigger
     intersectRatio: 0.2
+    triggerGroups:
+      types:
+      - SlipEntity
   - type: CollisionWake
     enabled: false
   - type: Physics

diff --git a/Resources/Prototypes/Entities/Objects/Devices/mousetrap.yml b/Resources/Prototypes/Entities/Objects/Devices/mousetrap.yml
@@ -13,6 +13,9 @@
     - type: StepTrigger
       intersectRatio: 0.2
       requiredTriggeredSpeed: 0
+      triggerGroups:
+        types:
+        - Mousetrap
     - type: Mousetrap
     - type: TriggerOnStepTrigger
     - type: ShoesRequiredStepTrigger

diff --git a/Resources/Prototypes/Entities/Objects/Devices/pda.yml b/Resources/Prototypes/Entities/Objects/Devices/pda.yml
@@ -272,6 +272,9 @@
     paralyzeTime: 4
     launchForwardsMultiplier: 1.5
   - type: StepTrigger
+    triggerGroups:
+      types:
+      - SlipEntity
   - type: CollisionWake
     enabled: false
   - type: Physics

diff --git a/Resources/Prototypes/Entities/Objects/Fun/dice.yml b/Resources/Prototypes/Entities/Objects/Fun/dice.yml
@@ -119,6 +119,9 @@
         mask:
         - ItemMask
   - type: StepTrigger
+    triggerGroups:
+      types:
+      - Shard
     intersectRatio: 0.2
   - type: TriggerOnStepTrigger
   - type: ShoesRequiredStepTrigger

diff --git a/Resources/Prototypes/Entities/Objects/Materials/shards.yml b/Resources/Prototypes/Entities/Objects/Materials/shards.yml
@@ -64,6 +64,9 @@
       - !type:DoActsBehavior
         acts: [ "Destruction" ]
   - type: StepTrigger
+    triggerGroups:
+      types:
+      - Shard
     intersectRatio: 0.2
   - type: ShoesRequiredStepTrigger
   - type: Slippery

diff --git a/Resources/Prototypes/Entities/Objects/Misc/land_mine.yml b/Resources/Prototypes/Entities/Objects/Misc/land_mine.yml
@@ -40,6 +40,9 @@
         params:
             maxDistance: 10
   - type: StepTrigger
+    triggerGroups:
+      types:
+      - Landmine
     requiredTriggeredSpeed: 0
     stepOn: true
 

diff --git a/Resources/Prototypes/Entities/Objects/Misc/spider_web.yml b/Resources/Prototypes/Entities/Objects/Misc/spider_web.yml
@@ -111,6 +111,9 @@
       paralyzeTime: 2
       launchForwardsMultiplier: 1.5
     - type: StepTrigger
+      triggerGroups:
+        types:
+        - SlipTile
       intersectRatio: 0.2
     - type: Physics
     - type: Fixtures

diff --git a/Resources/Prototypes/Entities/Objects/Specific/Janitorial/soap.yml b/Resources/Prototypes/Entities/Objects/Specific/Janitorial/soap.yml
@@ -24,6 +24,9 @@
     paralyzeTime: 2
     launchForwardsMultiplier: 1.5
   - type: StepTrigger
+    triggerGroups:
+      types:
+      - SlipEntity
     intersectRatio: 0.2
   - type: CollisionWake
     enabled: false
@@ -157,6 +160,9 @@
     paralyzeTime: 5
     launchForwardsMultiplier: 2.5
   - type: StepTrigger
+    triggerGroups:
+      types:
+      - SlipEntity
     intersectRatio: 0.04
   - type: Item
     heldPrefix: syndie
@@ -198,6 +204,9 @@
   - type: Slippery
     paralyzeTime: 2
   - type: StepTrigger
+    triggerGroups:
+      types:
+      - SlipEntity
   - type: Item
     heldPrefix: gibs
   - type: FlavorProfile

diff --git a/Resources/Prototypes/Entities/Tiles/bananium.yml b/Resources/Prototypes/Entities/Tiles/bananium.yml
@@ -47,6 +47,9 @@
     paralyzeTime: 2
     launchForwardsMultiplier: 1.5
   - type: StepTrigger
+    triggerGroups:
+      types:
+      - SlipTile
     intersectRatio: 0.2
   - type: Physics
     bodyType: Static

diff --git a/Resources/Prototypes/Entities/Tiles/chasm.yml b/Resources/Prototypes/Entities/Tiles/chasm.yml
@@ -14,6 +14,9 @@
     blacklist:
       tags:
       - Catwalk
+    triggerGroups:
+      types:
+      - Chasm
   - type: Transform
     anchored: true
   - type: Clickable
@@ -55,7 +58,7 @@
     sprite: Tiles/Planet/Chasms/chromite_chasm.rsi
   - type: Icon
     sprite: Tiles/Planet/Chasms/chromite_chasm.rsi
-    
+
 - type: entity
   parent: FloorChasmEntity
   id: FloorDesertChasm
@@ -65,7 +68,7 @@
     sprite: Tiles/Planet/Chasms/desert_chasm.rsi
   - type: Icon
     sprite: Tiles/Planet/Chasms/desert_chasm.rsi
-    
+
 - type: entity
   parent: FloorChasmEntity
   id: FloorSnowChasm
@@ -74,4 +77,4 @@
   - type: Sprite
     sprite: Tiles/Planet/Chasms/snow_chasm.rsi
   - type: Icon
-    sprite: Tiles/Planet/Chasms/snow_chasm.rsi
+    sprite: Tiles/Planet/Chasms/snow_chasm.rsi
diff --git a/Resources/Prototypes/Entities/Tiles/lava.yml b/Resources/Prototypes/Entities/Tiles/lava.yml
@@ -13,6 +13,9 @@
     blacklist:
       tags:
         - Catwalk
+    triggerGroups:
+      types:
+        - Lava
   - type: Lava
     fireStacks: 0.75
   - type: Transform