EmitSound prediction (#13282)

Content.Client/Sound/EmitSoundSystem.cs

@@ -0,0 +1,8 @@
+using Content.Shared.Sound;
+
+namespace Content.Client.Sound;
+
+public sealed class EmitSoundSystem : SharedEmitSoundSystem
+{
+
+}

Content.Server/Sound/Components/EmitSoundOnTriggerComponent.cs

@@ -1,4 +1,5 @@
 using Content.Server.Explosion.EntitySystems;
+using Content.Shared.Sound.Components;
 
 namespace Content.Server.Sound.Components
 {

Content.Server/Sound/Components/EmitSoundOnUIOpenComponent.cs

@@ -1,3 +1,5 @@
+using Content.Shared.Sound.Components;
+
 namespace Content.Server.Sound.Components
 {
     /// <summary>

Content.Server/Sound/Components/SpamEmitSoundComponent.cs

@@ -1,3 +1,5 @@
+using Content.Shared.Sound.Components;
+
 namespace Content.Server.Sound.Components
 {
     /// <summary>

Content.Server/Sound/EmitSoundSystem.cs

@@ -1,142 +1,53 @@
-using Content.Server.Explosion.EntitySystems;
+using Content.Server.Explosion.EntitySystems;
-using Content.Server.Interaction.Components;
 using Content.Server.Sound.Components;
-using Content.Server.Throwing;
 using Content.Server.UserInterface;
-using Content.Server.Popups;
+using Content.Shared.Sound;
-using Content.Shared.Hands;
-using Content.Shared.Interaction;
-using Content.Shared.Interaction.Events;
-using Content.Shared.Item;
-using Content.Shared.Maps;
-using Content.Shared.Throwing;
-using JetBrains.Annotations;
-using Robust.Shared.Map;
-using Robust.Shared.Player;
 using Robust.Shared.Random;
 
-namespace Content.Server.Sound
+namespace Content.Server.Sound;
+
+public sealed class EmitSoundSystem : SharedEmitSoundSystem
 {
-    /// <summary>
+    public override void Update(float frameTime)
-    /// Will play a sound on various events if the affected entity has a component derived from BaseEmitSoundComponent
-    /// </summary>
-    [UsedImplicitly]
-    public sealed class EmitSoundSystem : EntitySystem
     {
-        [Dependency] private readonly IMapManager _mapManager = default!;
+        base.Update(frameTime);
-        [Dependency] private readonly ITileDefinitionManager _tileDefMan = default!;
+        foreach (var soundSpammer in EntityQuery<SpamEmitSoundComponent>())
-        [Dependency] private readonly IRobustRandom _random = default!;
-        [Dependency] private readonly SharedAudioSystem _audioSystem = default!;
-        [Dependency] private readonly PopupSystem _popupSystem = default!;
-
-        /// <inheritdoc />
-
-        public override void Update(float frameTime)
         {
-            base.Update(frameTime);
+            if (!soundSpammer.Enabled)
-            foreach (var soundSpammer in EntityQuery<SpamEmitSoundComponent>())
+                continue;
+
+            soundSpammer.Accumulator += frameTime;
+            if (soundSpammer.Accumulator < soundSpammer.RollInterval)
             {
-                if (!soundSpammer.Enabled)
+                continue;
-                    continue;
+            }
+            soundSpammer.Accumulator -= soundSpammer.RollInterval;
 
-                soundSpammer.Accumulator += frameTime;
+            if (Random.Prob(soundSpammer.PlayChance))
-                if (soundSpammer.Accumulator < soundSpammer.RollInterval)
+            {
-                {
+                if (soundSpammer.PopUp != null)
-                    continue;
+                    Popup.PopupEntity(Loc.GetString(soundSpammer.PopUp), soundSpammer.Owner);
-                }
+                TryEmitSound(soundSpammer);
-                soundSpammer.Accumulator -= soundSpammer.RollInterval;
-
-                if (_random.Prob(soundSpammer.PlayChance))
-                {
-                    if (soundSpammer.PopUp != null)
-                        _popupSystem.PopupEntity(Loc.GetString(soundSpammer.PopUp), soundSpammer.Owner);
-                    TryEmitSound(soundSpammer);
-                }
             }
         }
-        public override void Initialize()
+    }
-        {
-            base.Initialize();
-            SubscribeLocalEvent<EmitSoundOnSpawnComponent, ComponentInit>(HandleEmitSpawnOnInit);
-            SubscribeLocalEvent<EmitSoundOnLandComponent, LandEvent>(HandleEmitSoundOnLand);
-            SubscribeLocalEvent<EmitSoundOnUseComponent, UseInHandEvent>(HandleEmitSoundOnUseInHand);
-            SubscribeLocalEvent<EmitSoundOnThrowComponent, ThrownEvent>(HandleEmitSoundOnThrown);
-            SubscribeLocalEvent<EmitSoundOnActivateComponent, ActivateInWorldEvent>(HandleEmitSoundOnActivateInWorld);
-            SubscribeLocalEvent<EmitSoundOnTriggerComponent, TriggerEvent>(HandleEmitSoundOnTrigger);
-            SubscribeLocalEvent<EmitSoundOnUIOpenComponent, AfterActivatableUIOpenEvent>(HandleEmitSoundOnUIOpen);
-            SubscribeLocalEvent<EmitSoundOnPickupComponent, GotEquippedHandEvent>(HandleEmitSoundOnPickup);
-            SubscribeLocalEvent<EmitSoundOnDropComponent, DroppedEvent>(HandleEmitSoundOnDrop);
-        }
 
-        private void HandleEmitSpawnOnInit(EntityUid uid, EmitSoundOnSpawnComponent component, ComponentInit args)
+    public override void Initialize()
-        {
+    {
-            TryEmitSound(component);
+        base.Initialize();
-        }
 
-        private void HandleEmitSoundOnTrigger(EntityUid uid, EmitSoundOnTriggerComponent component, TriggerEvent args)
+        SubscribeLocalEvent<EmitSoundOnTriggerComponent, TriggerEvent>(HandleEmitSoundOnTrigger);
-        {
+        SubscribeLocalEvent<EmitSoundOnUIOpenComponent, AfterActivatableUIOpenEvent>(HandleEmitSoundOnUIOpen);
-            TryEmitSound(component);
+    }
-            args.Handled = true;
-        }
 
-        private void HandleEmitSoundOnLand(EntityUid uid, BaseEmitSoundComponent component, LandEvent arg)
+    private void HandleEmitSoundOnUIOpen(EntityUid eUI, EmitSoundOnUIOpenComponent component, AfterActivatableUIOpenEvent args)
-        {
+    {
-            if (!TryComp<TransformComponent>(uid, out var xform) ||
+        TryEmitSound(component, args.User);
-                !_mapManager.TryGetGrid(xform.GridUid, out var grid)) return;
+    }
 
-            var tile = grid.GetTileRef(xform.Coordinates);
+    private void HandleEmitSoundOnTrigger(EntityUid uid, EmitSoundOnTriggerComponent component, TriggerEvent args)
-
+    {
-            // Handle maps being grids (we'll still emit the sound).
+        TryEmitSound(component, args.User);
-            if (xform.GridUid != xform.MapUid && tile.IsSpace(_tileDefMan))
+        args.Handled = true;
-                return;
-
-            TryEmitSound(component);
-        }
-
-        private void HandleEmitSoundOnUseInHand(EntityUid eUI, EmitSoundOnUseComponent component, UseInHandEvent arg)
-        {
-            // Intentionally not checking whether the interaction has already been handled.
-            TryEmitSound(component);
-
-            if (component.Handle)
-                arg.Handled = true;
-        }
-
-        private void HandleEmitSoundOnThrown(EntityUid eUI, BaseEmitSoundComponent component, ThrownEvent arg)
-        {
-            TryEmitSound(component);
-        }
-
-        private void HandleEmitSoundOnActivateInWorld(EntityUid eUI, EmitSoundOnActivateComponent component, ActivateInWorldEvent arg)
-        {
-            // Intentionally not checking whether the interaction has already been handled.
-            TryEmitSound(component);
-
-            if (component.Handle)
-                arg.Handled = true;
-        }
-
-        private void HandleEmitSoundOnUIOpen(EntityUid eUI, BaseEmitSoundComponent component, AfterActivatableUIOpenEvent arg)
-        {
-            TryEmitSound(component);
-        }
-
-        private void HandleEmitSoundOnPickup(EntityUid uid, EmitSoundOnPickupComponent component, GotEquippedHandEvent args)
-        {
-            TryEmitSound(component);
-        }
-
-        private void HandleEmitSoundOnDrop(EntityUid uid, EmitSoundOnDropComponent component, DroppedEvent args)
-        {
-            TryEmitSound(component);
-        }
-
-        private void TryEmitSound(BaseEmitSoundComponent component)
-        {
-            if (component.Sound == null)
-                return;
-            _audioSystem.PlayPvs(component.Sound, component.Owner, component.Sound.Params.AddVolume(-2f));
-        }
     }
 }
-

Content.Shared/Sound/Components/BaseEmitSoundComponent.cs

@@ -1,6 +1,6 @@
 using Robust.Shared.Audio;
 
-namespace Content.Server.Sound.Components
+namespace Content.Shared.Sound.Components
 {
     /// <summary>
     /// Base sound emitter which defines most of the data fields.

Content.Shared/Sound/Components/EmitSoundOnActivateComponent.cs

@@ -1,9 +1,11 @@
-namespace Content.Server.Sound.Components
+using Robust.Shared.GameStates;
+
+namespace Content.Shared.Sound.Components
 {
     /// <summary>
     /// Simple sound emitter that emits sound on ActivateInWorld
     /// </summary>
-    [RegisterComponent]
+    [RegisterComponent, NetworkedComponent]
     public sealed class EmitSoundOnActivateComponent : BaseEmitSoundComponent
     {
         /// <summary>

Content.Shared/Sound/Components/EmitSoundOnDropComponent.cs

@@ -1,9 +1,11 @@
-namespace Content.Server.Sound.Components
+using Robust.Shared.GameStates;
+
+namespace Content.Shared.Sound.Components
 {
     /// <summary>
     /// Simple sound emitter that emits sound on entity drop
     /// </summary>
-    [RegisterComponent]
+    [RegisterComponent, NetworkedComponent]
     public sealed class EmitSoundOnDropComponent : BaseEmitSoundComponent
     {
     }

Content.Shared/Sound/Components/EmitSoundOnLandComponent.cs

@@ -1,9 +1,11 @@
-namespace Content.Server.Sound.Components
+using Robust.Shared.GameStates;
+
+namespace Content.Shared.Sound.Components
 {
     /// <summary>
     /// Simple sound emitter that emits sound on LandEvent
     /// </summary>
-    [RegisterComponent]
+    [RegisterComponent, NetworkedComponent]
     public sealed class EmitSoundOnLandComponent : BaseEmitSoundComponent
     {
     }

Content.Shared/Sound/Components/EmitSoundOnPickupComponent.cs

@@ -1,9 +1,11 @@
-namespace Content.Server.Sound.Components
+using Robust.Shared.GameStates;
+
+namespace Content.Shared.Sound.Components
 {
     /// <summary>
     /// Simple sound emitter that emits sound on entity pickup
     /// </summary>
-    [RegisterComponent]
+    [RegisterComponent, NetworkedComponent]
     public sealed class EmitSoundOnPickupComponent : BaseEmitSoundComponent
     {
     }

Content.Shared/Sound/Components/EmitSoundOnSpawnComponent.cs

@@ -1,9 +1,11 @@
-namespace Content.Server.Sound.Components;
+using Robust.Shared.GameStates;
+
+namespace Content.Shared.Sound.Components;
 
 /// <summary>
 ///     Simple sound emitter that emits sound on entity spawn.
 /// </summary>
-[RegisterComponent]
+[RegisterComponent, NetworkedComponent]
 public sealed class EmitSoundOnSpawnComponent : BaseEmitSoundComponent
 {
 }

Content.Shared/Sound/Components/EmitSoundOnThrowComponent.cs

@@ -1,11 +1,11 @@
-using Content.Server.Sound.Components;
+using Robust.Shared.GameStates;
 
-namespace Content.Server.Throwing
+namespace Content.Shared.Sound.Components
 {
     /// <summary>
     /// Simple sound emitter that emits sound on ThrowEvent
     /// </summary>
-    [RegisterComponent]
+    [RegisterComponent, NetworkedComponent]
     public sealed class EmitSoundOnThrowComponent : BaseEmitSoundComponent
     {
     }

Content.Shared/Sound/Components/EmitSoundOnUseComponent.cs

@@ -1,6 +1,6 @@
-using Content.Server.Sound.Components;
+using Robust.Shared.GameStates;
 
-namespace Content.Server.Interaction.Components
+namespace Content.Shared.Sound.Components
 {
     /// <summary>
     /// Simple sound emitter that emits sound on UseInHand

Content.Shared/Sound/SharedEmitSoundSystem.cs

@@ -0,0 +1,111 @@
+using Content.Shared.Hands;
+using Content.Shared.Interaction;
+using Content.Shared.Interaction.Events;
+using Content.Shared.Maps;
+using Content.Shared.Popups;
+using Content.Shared.Sound.Components;
+using Content.Shared.Throwing;
+using JetBrains.Annotations;
+using Robust.Shared.Map;
+using Robust.Shared.Network;
+using Robust.Shared.Random;
+
+namespace Content.Shared.Sound
+{
+    /// <summary>
+    /// Will play a sound on various events if the affected entity has a component derived from BaseEmitSoundComponent
+    /// </summary>
+    [UsedImplicitly]
+    public abstract class SharedEmitSoundSystem : EntitySystem
+    {
+        [Dependency] private readonly INetManager _netMan = default!;
+        [Dependency] private readonly IMapManager _mapManager = default!;
+        [Dependency] private readonly ITileDefinitionManager _tileDefMan = default!;
+        [Dependency] protected readonly IRobustRandom Random = default!;
+        [Dependency] private readonly SharedAudioSystem _audioSystem = default!;
+        [Dependency] protected readonly SharedPopupSystem Popup = default!;
+
+        public override void Initialize()
+        {
+            base.Initialize();
+            SubscribeLocalEvent<EmitSoundOnSpawnComponent, ComponentInit>(HandleEmitSpawnOnInit);
+            SubscribeLocalEvent<EmitSoundOnLandComponent, LandEvent>(HandleEmitSoundOnLand);
+            SubscribeLocalEvent<EmitSoundOnUseComponent, UseInHandEvent>(HandleEmitSoundOnUseInHand);
+            SubscribeLocalEvent<EmitSoundOnThrowComponent, ThrownEvent>(HandleEmitSoundOnThrown);
+            SubscribeLocalEvent<EmitSoundOnActivateComponent, ActivateInWorldEvent>(HandleEmitSoundOnActivateInWorld);
+            SubscribeLocalEvent<EmitSoundOnPickupComponent, GotEquippedHandEvent>(HandleEmitSoundOnPickup);
+            SubscribeLocalEvent<EmitSoundOnDropComponent, DroppedEvent>(HandleEmitSoundOnDrop);
+        }
+
+        private void HandleEmitSpawnOnInit(EntityUid uid, EmitSoundOnSpawnComponent component, ComponentInit args)
+        {
+            TryEmitSound(component, predict: false);
+        }
+
+        private void HandleEmitSoundOnLand(EntityUid uid, BaseEmitSoundComponent component, LandEvent args)
+        {
+            if (!TryComp<TransformComponent>(uid, out var xform) ||
+                !_mapManager.TryGetGrid(xform.GridUid, out var grid))
+                return;
+
+            var tile = grid.GetTileRef(xform.Coordinates);
+
+            // Handle maps being grids (we'll still emit the sound).
+            if (xform.GridUid != xform.MapUid && tile.IsSpace(_tileDefMan))
+                return;
+
+            // hand throwing not predicted sadly
+            TryEmitSound(component, args.User, false);
+        }
+
+        private void HandleEmitSoundOnUseInHand(EntityUid eUI, EmitSoundOnUseComponent component, UseInHandEvent args)
+        {
+            // Intentionally not checking whether the interaction has already been handled.
+            TryEmitSound(component, args.User);
+
+            if (component.Handle)
+                args.Handled = true;
+        }
+
+        private void HandleEmitSoundOnThrown(EntityUid eUI, BaseEmitSoundComponent component, ThrownEvent args)
+        {
+            TryEmitSound(component, args.User, false);
+        }
+
+        private void HandleEmitSoundOnActivateInWorld(EntityUid eUI, EmitSoundOnActivateComponent component, ActivateInWorldEvent args)
+        {
+            // Intentionally not checking whether the interaction has already been handled.
+            TryEmitSound(component, args.User);
+
+            if (component.Handle)
+                args.Handled = true;
+        }
+
+        private void HandleEmitSoundOnPickup(EntityUid uid, EmitSoundOnPickupComponent component, GotEquippedHandEvent args)
+        {
+            TryEmitSound(component, args.User);
+        }
+
+        private void HandleEmitSoundOnDrop(EntityUid uid, EmitSoundOnDropComponent component, DroppedEvent args)
+        {
+            TryEmitSound(component, args.User);
+        }
+
+        protected void TryEmitSound(BaseEmitSoundComponent component, EntityUid? user=null, bool predict=true)
+        {
+            if (component.Sound == null)
+                return;
+
+            if (predict)
+            {
+                _audioSystem.PlayPredicted(component.Sound, component.Owner, user, component.Sound.Params.AddVolume(-2f));
+            }
+            else if (_netMan.IsServer)
+            {
+                // don't predict sounds that client couldn't have played already
+                _audioSystem.PlayPvs(component.Sound, component.Owner, component.Sound.Params.AddVolume(-2f));
+            }
+        }
+    }
+}
+