replacing sound (collection) names with SoundSpecifier - part 1

Content.Server/Stunnable/Components/StunbatonComponent.cs

@@ -1,4 +1,5 @@
 #nullable enable
+using Content.Shared.Sound;
 using Robust.Shared.GameObjects;
 using Robust.Shared.Serialization.Manager.Attributes;
 using Robust.Shared.ViewVariables;
@@ -31,5 +32,14 @@ namespace Content.Server.Stunnable.Components
         [ViewVariables(VVAccess.ReadWrite)]
         [DataField("energyPerUse")]
         public float EnergyPerUse { get; set; } = 50;
+
+        [DataField("stunSound")]
+        public SoundSpecifier StunSound { get; set; } = new SoundPathSpecifier("/Audio/Weapons/egloves.ogg");
+
+        [DataField("sparksSound")]
+        public SoundSpecifier SparksSound { get; set; } = new SoundCollectionSpecifier("sparks");
+
+        [DataField("turnOnFailSound")]
+        public SoundSpecifier TurnOnFailSound { get; set; } = new SoundPathSpecifier("/Audio/Machines/button.ogg");
     }
 }

Content.Server/Stunnable/Components/StunnableComponent.cs

@@ -4,6 +4,7 @@ using Content.Server.Notification;
 using Content.Shared.Audio;
 using Content.Shared.MobState;
 using Content.Shared.Notification.Managers;
+using Content.Shared.Sound;
 using Content.Shared.Standing;
 using Content.Shared.Stunnable;
 using Robust.Shared.Audio;
@@ -12,6 +13,7 @@ using Robust.Shared.IoC;
 using Robust.Shared.Localization;
 using Robust.Shared.Player;
 using Robust.Shared.Random;
+using Robust.Shared.Serialization.Manager.Attributes;
 
 namespace Content.Server.Stunnable.Components
 {
@@ -19,6 +21,8 @@ namespace Content.Server.Stunnable.Components
     [ComponentReference(typeof(SharedStunnableComponent))]
     public class StunnableComponent : SharedStunnableComponent, IDisarmedAct
     {
+        [DataField("stunAttemptSound")] private SoundSpecifier _stunAttemptSound = new SoundPathSpecifier("/Audio/Effects/thudswoosh.ogg");
+
         protected override void OnKnockdown()
         {
             EntitySystem.Get<StandingStateSystem>().Down(Owner);
@@ -54,7 +58,8 @@ namespace Content.Server.Stunnable.Components
 
         protected override void OnInteractHand()
         {
-            SoundSystem.Play(Filter.Pvs(Owner), "/Audio/Effects/thudswoosh.ogg", Owner, AudioHelpers.WithVariation(0.05f));
+            if(_stunAttemptSound.TryGetSound(out var sound))
+                SoundSystem.Play(Filter.Pvs(Owner), sound, Owner, AudioHelpers.WithVariation(0.05f));
         }
 
         bool IDisarmedAct.Disarmed(DisarmedActEventArgs eventArgs)
@@ -69,8 +74,8 @@ namespace Content.Server.Stunnable.Components
 
             if (source != null)
             {
-                SoundSystem.Play(Filter.Pvs(source), "/Audio/Effects/thudswoosh.ogg", source,
-                    AudioHelpers.WithVariation(0.025f));
+                if (_stunAttemptSound.TryGetSound(out var sound))
+                    SoundSystem.Play(Filter.Pvs(source), sound, source, AudioHelpers.WithVariation(0.025f));
                 if (target != null)
                 {
                     source.PopupMessageOtherClients(Loc.GetString("stunnable-component-disarm-success-others", ("source", source.Name),("target", target.Name)));

Content.Server/Stunnable/StunbatonSystem.cs

@@ -1,4 +1,4 @@
-using System.Linq;
+using System.Linq;
 using Content.Server.Items;
 using Content.Server.PowerCell.Components;
 using Content.Server.Stunnable.Components;
@@ -119,7 +119,8 @@ namespace Content.Server.Stunnable
         {
             if (!entity.TryGetComponent(out StunnableComponent? stunnable) || !comp.Activated) return;
 
-            SoundSystem.Play(Filter.Pvs(comp.Owner), "/Audio/Weapons/egloves.ogg", comp.Owner.Transform.Coordinates, AudioHelpers.WithVariation(0.25f));
+            if(comp.StunSound.TryGetSound(out var stunSound))
+                SoundSystem.Play(Filter.Pvs(comp.Owner), stunSound, comp.Owner.Transform.Coordinates, AudioHelpers.WithVariation(0.25f));
             if(!stunnable.SlowedDown)
             {
                 if(_robustRandom.Prob(comp.ParalyzeChanceNoSlowdown))
@@ -136,9 +137,11 @@ namespace Content.Server.Stunnable
             }
 
 
-            if (!comp.Owner.TryGetComponent<PowerCellSlotComponent>(out var slot) || slot.Cell == null || !(slot.Cell.CurrentCharge < comp.EnergyPerUse)) return;
+            if (!comp.Owner.TryGetComponent<PowerCellSlotComponent>(out var slot) || slot.Cell == null || !(slot.Cell.CurrentCharge < comp.EnergyPerUse))
+                return;
 
-            SoundSystem.Play(Filter.Pvs(comp.Owner), AudioHelpers.GetRandomFileFromSoundCollection("sparks"), comp.Owner.Transform.Coordinates, AudioHelpers.WithVariation(0.25f));
+            if(comp.SparksSound.TryGetSound(out var sparksSound))
+                SoundSystem.Play(Filter.Pvs(comp.Owner), sparksSound, comp.Owner.Transform.Coordinates, AudioHelpers.WithVariation(0.25f));
             TurnOff(comp);
         }
 
@@ -152,7 +155,8 @@ namespace Content.Server.Stunnable
             if (!comp.Owner.TryGetComponent<SpriteComponent>(out var sprite) ||
                 !comp.Owner.TryGetComponent<ItemComponent>(out var item)) return;
 
-            SoundSystem.Play(Filter.Pvs(comp.Owner), AudioHelpers.GetRandomFileFromSoundCollection("sparks"), comp.Owner.Transform.Coordinates, AudioHelpers.WithVariation(0.25f));
+            if(comp.SparksSound.TryGetSound(out var sparksSound))
+                SoundSystem.Play(Filter.Pvs(comp.Owner), sparksSound, comp.Owner.Transform.Coordinates, AudioHelpers.WithVariation(0.25f));
             item.EquippedPrefix = "off";
             // TODO stunbaton visualizer
             sprite.LayerSetState(0, "stunbaton_off");
@@ -167,7 +171,8 @@ namespace Content.Server.Stunnable
             }
 
             if (!comp.Owner.TryGetComponent<SpriteComponent>(out var sprite) ||
-                !comp.Owner.TryGetComponent<ItemComponent>(out var item)) return;
+                !comp.Owner.TryGetComponent<ItemComponent>(out var item))
+                return;
 
             var playerFilter = Filter.Pvs(comp.Owner);
             if (!comp.Owner.TryGetComponent<PowerCellSlotComponent>(out var slot))
@@ -175,19 +180,22 @@ namespace Content.Server.Stunnable
 
             if (slot.Cell == null)
             {
-                SoundSystem.Play(playerFilter, "/Audio/Machines/button.ogg", comp.Owner.Transform.Coordinates, AudioHelpers.WithVariation(0.25f));
+                if(comp.TurnOnFailSound.TryGetSound(out var turnOnFailSound))
+                    SoundSystem.Play(playerFilter, turnOnFailSound, comp.Owner.Transform.Coordinates, AudioHelpers.WithVariation(0.25f));
                 user.PopupMessage(Loc.GetString("comp-stunbaton-activated-missing-cell"));
                 return;
             }
 
             if (slot.Cell != null && slot.Cell.CurrentCharge < comp.EnergyPerUse)
             {
-                SoundSystem.Play(playerFilter, "/Audio/Machines/button.ogg", comp.Owner.Transform.Coordinates, AudioHelpers.WithVariation(0.25f));
+                if(comp.TurnOnFailSound.TryGetSound(out var turnOnFailSound))
+                    SoundSystem.Play(playerFilter, turnOnFailSound, comp.Owner.Transform.Coordinates, AudioHelpers.WithVariation(0.25f));
                 user.PopupMessage(Loc.GetString("comp-stunbaton-activated-dead-cell"));
                 return;
             }
 
-            SoundSystem.Play(playerFilter, AudioHelpers.GetRandomFileFromSoundCollection("sparks"), comp.Owner.Transform.Coordinates, AudioHelpers.WithVariation(0.25f));
+            if(comp.SparksSound.TryGetSound(out var sparksSound))
+                SoundSystem.Play(playerFilter, sparksSound, comp.Owner.Transform.Coordinates, AudioHelpers.WithVariation(0.25f));
 
             item.EquippedPrefix = "on";
             sprite.LayerSetState(0, "stunbaton_on");