Mirror: SlowContactsSystem to SpeedModifierContactsSystem mini rework (…

…#235) ## Mirror of PR #26110: [SlowContactsSystem to SpeedModifierContactsSystem mini rework](space-wizards/space-station-14#26110) from <img src="https://avatars.githubusercontent.com/u/10567778?v=4" alt="space-wizards" width="22"/> [space-wizards](https://github.com/space-wizards)/[space-station-14](https://github.com/space-wizards/space-station-14) ###### `c35ff87e146f0cda7c10782f4ab80b784b51e5fe` PR opened by <img src="https://avatars.githubusercontent.com/u/96445749?v=4" width="16"/><a href="https://github.com/TheShuEd"> TheShuEd</a> at 2024-03-14 09:45:33 UTC --- PR changed 9 files with 42 additions and 34 deletions. The PR had the following labels: - Status: Needs Review --- <details open="true"><summary><h1>Original Body</h1></summary> > ## About the PR > system and components are renamed. It can now be used including to accelerate entities > > ## Why / Balance > more reusability for the system > > ## Technical details > Now the system calculates the arithmetic mean of all the entities that affects your speed. </details> Co-authored-by: SimpleStation14 <Unknown>
Simple-Station · May 12, 2024 · 3b2eb13 · 3b2eb13
1 parent 959dca1
commit 3b2eb13
Show file tree

Hide file tree

Showing 9 changed files with 42 additions and 34 deletions.
diff --git a/Content.Server/Chemistry/TileReactions/SpillTileReaction.cs b/Content.Server/Chemistry/TileReactions/SpillTileReaction.cs
@@ -45,9 +45,9 @@ public FixedPoint2 TileReact(TileRef tile, ReagentPrototype reagent, FixedPoint2
                 var step = entityManager.EnsureComponent<StepTriggerComponent>(puddleUid);
                 entityManager.EntitySysManager.GetEntitySystem<StepTriggerSystem>().SetRequiredTriggerSpeed(puddleUid, _requiredSlipSpeed, step);
 
-                var slow = entityManager.EnsureComponent<SlowContactsComponent>(puddleUid);
+                var slow = entityManager.EnsureComponent<SpeedModifierContactsComponent>(puddleUid);
                 var speedModifier = 1 - reagent.Viscosity;
-                entityManager.EntitySysManager.GetEntitySystem<SlowContactsSystem>().ChangeModifiers(puddleUid, speedModifier, slow);
+                entityManager.EntitySysManager.GetEntitySystem<SpeedModifierContactsSystem>().ChangeModifiers(puddleUid, speedModifier, slow);
 
                 return reactVolume;
             }

diff --git a/Content.Server/Fluids/EntitySystems/PuddleSystem.cs b/Content.Server/Fluids/EntitySystems/PuddleSystem.cs
@@ -54,7 +54,7 @@ public sealed partial class PuddleSystem : SharedPuddleSystem
     [Dependency] private readonly SharedPopupSystem _popups = default!;
     [Dependency] private readonly SolutionContainerSystem _solutionContainerSystem = default!;
     [Dependency] private readonly StepTriggerSystem _stepTrigger = default!;
-    [Dependency] private readonly SlowContactsSystem _slowContacts = default!;
+    [Dependency] private readonly SpeedModifierContactsSystem _speedModContacts = default!;
     [Dependency] private readonly TileFrictionController _tile = default!;
 
     [ValidatePrototypeId<ReagentPrototype>]
@@ -435,13 +435,13 @@ private void UpdateSlow(EntityUid uid, Solution solution)
 
         if (maxViscosity > 0)
         {
-            var comp = EnsureComp<SlowContactsComponent>(uid);
+            var comp = EnsureComp<SpeedModifierContactsComponent>(uid);
             var speed = 1 - maxViscosity;
-            _slowContacts.ChangeModifiers(uid, speed, comp);
+            _speedModContacts.ChangeModifiers(uid, speed, comp);
         }
         else
         {
-            RemComp<SlowContactsComponent>(uid);
+            RemComp<SpeedModifierContactsComponent>(uid);
         }
     }
 

diff --git a/...nt/Components/SlowedByContactComponent.cs → ...onents/SpeedModifiedByContactComponent.cs b/...nt/Components/SlowedByContactComponent.cs → ...onents/SpeedModifiedByContactComponent.cs
@@ -7,6 +7,6 @@ namespace Content.Shared.Movement.Components;
 /// Exists just to listen to a single event. What a life.
 /// </summary>
 [NetworkedComponent, RegisterComponent] // must be networked to properly predict adding & removal
-public sealed partial class SlowedByContactComponent : Component
+public sealed partial class SpeedModifiedByContactComponent : Component
 {
 }
diff --git a/...ement/Components/SlowContactsComponent.cs → ...ponents/SpeedModifierContactsComponent.cs b/...ement/Components/SlowContactsComponent.cs → ...ponents/SpeedModifierContactsComponent.cs
@@ -6,8 +6,8 @@ namespace Content.Shared.Movement.Components;
 
 [NetworkedComponent, RegisterComponent]
 [AutoGenerateComponentState]
-[Access(typeof(SlowContactsSystem))]
-public sealed partial class SlowContactsComponent : Component
+[Access(typeof(SpeedModifierContactsSystem))]
+public sealed partial class SpeedModifierContactsComponent : Component
 {
     [DataField("walkSpeedModifier"), ViewVariables(VVAccess.ReadWrite)]
     [AutoNetworkedField]

diff --git a/Content.Shared/Movement/Systems/FrictionContactsSystem.cs b/Content.Shared/Movement/Systems/FrictionContactsSystem.cs
@@ -10,7 +10,7 @@ public sealed class FrictionContactsSystem : EntitySystem
     [Dependency] private readonly SharedPhysicsSystem _physics = default!;
     [Dependency] private readonly MovementSpeedModifierSystem _speedModifierSystem = default!;
 
-    // Comment copied from "original" SlowContactsSystem.cs
+    // Comment copied from "original" SlowContactsSystem.cs (now SpeedModifierContactsSystem.cs)
     // TODO full-game-save 
     // Either these need to be processed before a map is saved, or slowed/slowing entities need to update on init.
     private HashSet<EntityUid> _toUpdate = new();

diff --git a/...ed/Movement/Systems/SlowContactsSystem.cs → ...nt/Systems/SpeedModifierContactsSystem.cs b/...ed/Movement/Systems/SlowContactsSystem.cs → ...nt/Systems/SpeedModifierContactsSystem.cs
@@ -5,7 +5,7 @@
 
 namespace Content.Shared.Movement.Systems;
 
-public sealed class SlowContactsSystem : EntitySystem
+public sealed class SpeedModifierContactsSystem : EntitySystem
 {
     [Dependency] private readonly SharedPhysicsSystem _physics = default!;
     [Dependency] private readonly MovementSpeedModifierSystem _speedModifierSystem = default!;
@@ -18,10 +18,10 @@ public sealed class SlowContactsSystem : EntitySystem
     public override void Initialize()
     {
         base.Initialize();
-        SubscribeLocalEvent<SlowContactsComponent, StartCollideEvent>(OnEntityEnter);
-        SubscribeLocalEvent<SlowContactsComponent, EndCollideEvent>(OnEntityExit);
-        SubscribeLocalEvent<SlowedByContactComponent, RefreshMovementSpeedModifiersEvent>(MovementSpeedCheck);
-        SubscribeLocalEvent<SlowContactsComponent, ComponentShutdown>(OnShutdown);
+        SubscribeLocalEvent<SpeedModifierContactsComponent, StartCollideEvent>(OnEntityEnter);
+        SubscribeLocalEvent<SpeedModifierContactsComponent, EndCollideEvent>(OnEntityExit);
+        SubscribeLocalEvent<SpeedModifiedByContactComponent, RefreshMovementSpeedModifiersEvent>(MovementSpeedCheck);
+        SubscribeLocalEvent<SpeedModifierContactsComponent, ComponentShutdown>(OnShutdown);
 
         UpdatesAfter.Add(typeof(SharedPhysicsSystem));
     }
@@ -39,18 +39,18 @@ public override void Update(float frameTime)
 
         foreach (var ent in _toRemove)
         {
-            RemComp<SlowedByContactComponent>(ent);
+            RemComp<SpeedModifiedByContactComponent>(ent);
         }
 
         _toUpdate.Clear();
     }
 
-    public void ChangeModifiers(EntityUid uid, float speed, SlowContactsComponent? component = null)
+    public void ChangeModifiers(EntityUid uid, float speed, SpeedModifierContactsComponent? component = null)
     {
         ChangeModifiers(uid, speed, speed, component);
     }
 
-    public void ChangeModifiers(EntityUid uid, float walkSpeed, float sprintSpeed, SlowContactsComponent? component = null)
+    public void ChangeModifiers(EntityUid uid, float walkSpeed, float sprintSpeed, SpeedModifierContactsComponent? component = null)
     {
         if (!Resolve(uid, ref component))
         {
@@ -62,7 +62,7 @@ public void ChangeModifiers(EntityUid uid, float walkSpeed, float sprintSpeed, S
         _toUpdate.UnionWith(_physics.GetContactingEntities(uid));
     }
 
-    private void OnShutdown(EntityUid uid, SlowContactsComponent component, ComponentShutdown args)
+    private void OnShutdown(EntityUid uid, SpeedModifierContactsComponent component, ComponentShutdown args)
     {
         if (!TryComp(uid, out PhysicsComponent? phys))
             return;
@@ -71,48 +71,56 @@ private void OnShutdown(EntityUid uid, SlowContactsComponent component, Componen
         _toUpdate.UnionWith(_physics.GetContactingEntities(uid, phys));
     }
 
-    private void MovementSpeedCheck(EntityUid uid, SlowedByContactComponent component, RefreshMovementSpeedModifiersEvent args)
+    private void MovementSpeedCheck(EntityUid uid, SpeedModifiedByContactComponent component, RefreshMovementSpeedModifiersEvent args)
     {
         if (!EntityManager.TryGetComponent<PhysicsComponent>(uid, out var physicsComponent))
             return;
 
-        var walkSpeed = 1.0f;
-        var sprintSpeed = 1.0f;
+        var walkSpeed = 0.0f;
+        var sprintSpeed = 0.0f;
 
         bool remove = true;
+        var entries = 0;
         foreach (var ent in _physics.GetContactingEntities(uid, physicsComponent))
         {
-            if (!TryComp<SlowContactsComponent>(ent, out var slowContactsComponent))
+            if (!TryComp<SpeedModifierContactsComponent>(ent, out var slowContactsComponent))
                 continue;
 
             if (slowContactsComponent.IgnoreWhitelist != null && slowContactsComponent.IgnoreWhitelist.IsValid(uid))
                 continue;
 
-            walkSpeed = Math.Min(walkSpeed, slowContactsComponent.WalkSpeedModifier);
-            sprintSpeed = Math.Min(sprintSpeed, slowContactsComponent.SprintSpeedModifier);
+            walkSpeed += slowContactsComponent.WalkSpeedModifier;
+            sprintSpeed += slowContactsComponent.SprintSpeedModifier;
             remove = false;
+            entries++;
         }
 
-        args.ModifySpeed(walkSpeed, sprintSpeed);
+        if (entries > 0)
+        {
+            walkSpeed /= entries;
+            sprintSpeed /= entries;
+
+            args.ModifySpeed(walkSpeed, sprintSpeed);
+        }
 
         // no longer colliding with anything
         if (remove)
             _toRemove.Add(uid);
     }
 
-    private void OnEntityExit(EntityUid uid, SlowContactsComponent component, ref EndCollideEvent args)
+    private void OnEntityExit(EntityUid uid, SpeedModifierContactsComponent component, ref EndCollideEvent args)
     {
         var otherUid = args.OtherEntity;
         _toUpdate.Add(otherUid);
     }
 
-    private void OnEntityEnter(EntityUid uid, SlowContactsComponent component, ref StartCollideEvent args)
+    private void OnEntityEnter(EntityUid uid, SpeedModifierContactsComponent component, ref StartCollideEvent args)
     {
         var otherUid = args.OtherEntity;
         if (!HasComp<MovementSpeedModifierComponent>(otherUid))
             return;
 
-        EnsureComp<SlowedByContactComponent>(otherUid);
+        EnsureComp<SpeedModifiedByContactComponent>(otherUid);
         _toUpdate.Add(otherUid);
     }
 }
diff --git a/Resources/Prototypes/Entities/Objects/Misc/kudzu.yml b/Resources/Prototypes/Entities/Objects/Misc/kudzu.yml
@@ -82,7 +82,7 @@
     - type: AtmosExposed
       growthTickChance: 0.3
       spreadChance: 0.4
-    - type: SlowContacts
+    - type: SpeedModifierContacts
       walkSpeedModifier: 0.2
       sprintSpeedModifier: 0.2
       ignoreWhitelist:
@@ -123,7 +123,7 @@
     - type: Kudzu
       spriteVariants: 5
       spreadChance: 0.01
-    - type: SlowContacts
+    - type: SpeedModifierContacts
       walkSpeedModifier: 0.8
       sprintSpeedModifier: 0.8
       ignoreWhitelist:
@@ -237,7 +237,7 @@
          Heat: 3
       growthTickChance: 0.3
     - type: AtmosExposed
-    - type: SlowContacts
+    - type: SpeedModifierContacts
       walkSpeedModifier: 0.3
       sprintSpeedModifier: 0.3
       ignoreWhitelist:

diff --git a/Resources/Prototypes/Entities/Objects/Misc/spider_web.yml b/Resources/Prototypes/Entities/Objects/Misc/spider_web.yml
@@ -72,7 +72,7 @@
         Flammable: [Touch]
         Extinguish: [Touch]
     - type: SpiderWebObject
-    - type: SlowContacts
+    - type: SpeedModifierContacts
       walkSpeedModifier: 0.5
       sprintSpeedModifier: 0.5
       ignoreWhitelist:

diff --git a/Resources/Prototypes/Entities/Tiles/water.yml b/Resources/Prototypes/Entities/Tiles/water.yml
@@ -32,7 +32,7 @@
         Quantity: 100
   - type: DrainableSolution
     solution: pool
-  - type: SlowContacts
+  - type: SpeedModifierContacts
     walkSpeedModifier: 0.5
     sprintSpeedModifier: 0.5
   - type: Physics