From 748b79d1dff792d4d216e9793aaa4dd83676af37 Mon Sep 17 00:00:00 2001
From: metalgearsloth <31366439+metalgearsloth@users.noreply.github.com>
Date: Mon, 12 Dec 2022 00:18:25 +1100
Subject: [PATCH] Fix duplicate mech footstep sounds (#12972)

* Fix duplicate mech footstep sounds

We just add a new component for relay targets so we can use that for audio prediction.

* Fix cwash

* woop
---
 .../Physics/Controllers/MoverController.cs    |  2 +-
 .../Physics/Controllers/MoverController.cs    |  2 +-
 .../MovementRelayTargetComponent.cs           | 12 +++
 .../Systems/SharedMoverController.Relay.cs    | 82 ++++++++++++++++++-
 .../Movement/Systems/SharedMoverController.cs | 13 ++-
 5 files changed, 106 insertions(+), 5 deletions(-)
 create mode 100644 Content.Shared/Movement/Components/MovementRelayTargetComponent.cs

diff --git a/Content.Client/Physics/Controllers/MoverController.cs b/Content.Client/Physics/Controllers/MoverController.cs
index 7cf1e72255..2baebe1182 100644
--- a/Content.Client/Physics/Controllers/MoverController.cs
+++ b/Content.Client/Physics/Controllers/MoverController.cs
@@ -140,7 +140,7 @@ namespace Content.Client.Physics.Controllers
 
         protected override bool CanSound()
         {
-            return _timing.IsFirstTimePredicted && _timing.InSimulation;
+            return _timing is { IsFirstTimePredicted: true, InSimulation: true };
         }
     }
 }
diff --git a/Content.Server/Physics/Controllers/MoverController.cs b/Content.Server/Physics/Controllers/MoverController.cs
index 0793b07e77..6e46fa0e13 100644
--- a/Content.Server/Physics/Controllers/MoverController.cs
+++ b/Content.Server/Physics/Controllers/MoverController.cs
@@ -84,7 +84,7 @@ namespace Content.Server.Physics.Controllers
                 }
 
                 PhysicsComponent? body = null;
-                TransformComponent? xformMover = xform;
+                var xformMover = xform;
 
                 if (mover.ToParent && relayQuery.HasComponent(xform.ParentUid))
                 {
diff --git a/Content.Shared/Movement/Components/MovementRelayTargetComponent.cs b/Content.Shared/Movement/Components/MovementRelayTargetComponent.cs
new file mode 100644
index 0000000000..18776ab5b0
--- /dev/null
+++ b/Content.Shared/Movement/Components/MovementRelayTargetComponent.cs
@@ -0,0 +1,12 @@
+using Robust.Shared.GameStates;
+
+namespace Content.Shared.Movement.Components;
+
+[RegisterComponent, NetworkedComponent]
+public sealed class MovementRelayTargetComponent : Component
+{
+    /// <summary>
+    /// Entities that are relaying to us.
+    /// </summary>
+    [ViewVariables] public readonly List<EntityUid> Entities = new();
+}
diff --git a/Content.Shared/Movement/Systems/SharedMoverController.Relay.cs b/Content.Shared/Movement/Systems/SharedMoverController.Relay.cs
index 77ed9e9755..67595bbabe 100644
--- a/Content.Shared/Movement/Systems/SharedMoverController.Relay.cs
+++ b/Content.Shared/Movement/Systems/SharedMoverController.Relay.cs
@@ -12,6 +12,10 @@ public abstract partial class SharedMoverController
         SubscribeLocalEvent<RelayInputMoverComponent, ComponentGetState>(OnRelayGetState);
         SubscribeLocalEvent<RelayInputMoverComponent, ComponentHandleState>(OnRelayHandleState);
         SubscribeLocalEvent<RelayInputMoverComponent, ComponentShutdown>(OnRelayShutdown);
+
+        SubscribeLocalEvent<MovementRelayTargetComponent, ComponentGetState>(OnTargetRelayGetState);
+        SubscribeLocalEvent<MovementRelayTargetComponent, ComponentHandleState>(OnTargetRelayHandleState);
+        SubscribeLocalEvent<MovementRelayTargetComponent, ComponentShutdown>(OnTargetRelayShutdown);
     }
 
     /// <summary>
@@ -20,7 +24,7 @@ public abstract partial class SharedMoverController
     /// </summary>
     public void SetRelay(EntityUid uid, EntityUid relayEntity, RelayInputMoverComponent? component = null)
     {
-        if (!Resolve(uid, ref component))
+        if (!Resolve(uid, ref component) || component.RelayEntity == relayEntity)
             return;
 
         if (uid == relayEntity)
@@ -29,14 +33,38 @@ public abstract partial class SharedMoverController
             return;
         }
 
+        if (TryComp<MovementRelayTargetComponent>(relayEntity, out var targetComp))
+        {
+            targetComp.Entities.Remove(uid);
+
+            if (targetComp.Entities.Count == 0)
+                RemComp<MovementRelayTargetComponent>(relayEntity);
+        }
+
         component.RelayEntity = relayEntity;
+        targetComp = EnsureComp<MovementRelayTargetComponent>(relayEntity);
+        targetComp.Entities.Add(uid);
         Dirty(component);
+        Dirty(targetComp);
     }
 
     private void OnRelayShutdown(EntityUid uid, RelayInputMoverComponent component, ComponentShutdown args)
     {
         // If relay is removed then cancel all inputs.
-        if (!TryComp<InputMoverComponent>(component.RelayEntity, out var inputMover)) return;
+        if (!TryComp<InputMoverComponent>(component.RelayEntity, out var inputMover))
+            return;
+
+        if (TryComp<MovementRelayTargetComponent>(component.RelayEntity, out var targetComp) &&
+            targetComp.LifeStage < ComponentLifeStage.Stopping)
+        {
+            targetComp.Entities.Remove(uid);
+
+            if (targetComp.Entities.Count == 0)
+                RemCompDeferred<MovementRelayTargetComponent>(component.RelayEntity.Value);
+            else
+                Dirty(targetComp);
+        }
+
         SetMoveInput(inputMover, MoveButtons.None);
     }
 
@@ -56,9 +84,59 @@ public abstract partial class SharedMoverController
         };
     }
 
+    #region Target Relay
+
+    private void OnTargetRelayShutdown(EntityUid uid, MovementRelayTargetComponent component, ComponentShutdown args)
+    {
+        if (component.Entities.Count == 0)
+            return;
+
+        var relayQuery = GetEntityQuery<RelayInputMoverComponent>();
+
+        foreach (var ent in component.Entities)
+        {
+            if (!relayQuery.TryGetComponent(ent, out var relay))
+                continue;
+
+            DebugTools.Assert(relay.RelayEntity == uid);
+
+            if (relay.RelayEntity != uid)
+                continue;
+
+            RemCompDeferred<RelayInputMoverComponent>(ent);
+        }
+    }
+
+    private void OnTargetRelayHandleState(EntityUid uid, MovementRelayTargetComponent component, ref ComponentHandleState args)
+    {
+        if (args.Current is not MovementRelayTargetComponentState state)
+            return;
+
+        component.Entities.Clear();
+        component.Entities.AddRange(state.Entities);
+    }
+
+    private void OnTargetRelayGetState(EntityUid uid, MovementRelayTargetComponent component, ref ComponentGetState args)
+    {
+        args.State = new MovementRelayTargetComponentState(component.Entities);
+    }
+
+    #endregion
+
     [Serializable, NetSerializable]
     private sealed class RelayInputMoverComponentState : ComponentState
     {
         public EntityUid? Entity;
     }
+
+    [Serializable, NetSerializable]
+    private sealed class MovementRelayTargetComponentState : ComponentState
+    {
+        public List<EntityUid> Entities;
+
+        public MovementRelayTargetComponentState(List<EntityUid> entities)
+        {
+            Entities = entities;
+        }
+    }
 }
diff --git a/Content.Shared/Movement/Systems/SharedMoverController.cs b/Content.Shared/Movement/Systems/SharedMoverController.cs
index 328b2b5e0d..6a8b4ebfd7 100644
--- a/Content.Shared/Movement/Systems/SharedMoverController.cs
+++ b/Content.Shared/Movement/Systems/SharedMoverController.cs
@@ -287,7 +287,18 @@ namespace Content.Shared.Movement.Systems
                         .WithVolume(FootstepVolume * soundModifier)
                         .WithVariation(sound.Params.Variation ?? FootstepVariation);
 
-                    _audio.PlayPredicted(sound, mover.Owner, mover.Owner, audioParams);
+                    // If we're a relay target then predict the sound for all relays.
+                    if (TryComp<MovementRelayTargetComponent>(mover.Owner, out var targetComp))
+                    {
+                        foreach (var ent in targetComp.Entities)
+                        {
+                            _audio.PlayPredicted(sound, mover.Owner, ent, audioParams);
+                        }
+                    }
+                    else
+                    {
+                        _audio.PlayPredicted(sound, mover.Owner, mover.Owner, audioParams);
+                    }
                 }
             }