Add a Client Toggle for StunVisuals (DeltaV-Station#5831)

* OneCommitOps

* Update DCCVars.cs

Signed-off-by: Sir Warock <67167466+SirWarock@users.noreply.github.com>

---------

Signed-off-by: Sir Warock <67167466+SirWarock@users.noreply.github.com>

Author: SirWarock

Content.Client/Stunnable/StunSystem.cs

@@ -1,10 +1,12 @@
 using System.Numerics;
+using Content.Shared._DV.CCVars; // DeltaV - Enable Stars via CVar.
 using Content.Shared.CombatMode;
 using Content.Shared.Interaction;
 using Content.Shared.Stunnable;
 using Robust.Client.Animations;
 using Robust.Client.GameObjects;
 using Robust.Shared.Animations;
+using Robust.Shared.Configuration; // DeltaV - Enable Stars via CVar.
 using Robust.Shared.Input;
 using Robust.Shared.Input.Binding;
 using Robust.Shared.Random;
@@ -13,6 +15,7 @@ namespace Content.Client.Stunnable;
 
 public sealed class StunSystem : SharedStunSystem
 {
+    [Dependency] private readonly IConfigurationManager _cfg = default!; // DeltaV - Enable Stars via CVar.
     [Dependency] private readonly SharedCombatModeSystem _combat = default!;
     [Dependency] private readonly IRobustRandom _random = default!;
     [Dependency] private readonly SpriteSystem _spriteSystem = default!;
@@ -78,6 +81,9 @@ private void UpdateAppearance(Entity<SpriteComponent?> entity, string state)
 
         var visible = Appearance.TryGetData<bool>(entity, StunVisuals.SeeingStars, out var stars) && stars;
 
+        if (visible && !_cfg.GetCVar(DCCVars.ShowStunVisuals)) // DeltaV - Enable Stars via CVar.
+            visible = false;
+
         _spriteSystem.LayerSetVisible((entity, entity.Comp), index, visible);
         _spriteSystem.LayerSetRsiState((entity, entity.Comp), index, state);
     }

Content.Client/_DV/Options/UI/Tabs/DeltaTab.xaml

@@ -9,6 +9,7 @@
                    StyleClasses="LabelKeyText"/>
             <CheckBox Name="DisableFiltersCheckBox" Text="{Loc 'ui-options-no-filters'}" />
             <CheckBox Name="DisableGlimmerEffectCheckBox" Text="{Loc 'ui-options-disable-glimmer-effect'}" />
+            <CheckBox Name="EnableStunVisualsCheckBox" Text="{Loc 'ui-options-enable-stun-visuals'}" />
             <Label Text="{Loc 'ui-options-delta-tips'}"
                    StyleClasses="LabelKeyText"/>
             <CheckBox Name="DisableTipsCheckBox" Text="{Loc 'ui-options-delta-disable-tips'}" />

Content.Client/_DV/Options/UI/Tabs/DeltaTab.xaml.cs

@@ -18,6 +18,7 @@ public DeltaTab()
 
         Control.AddOptionCheckBox(DCCVars.NoVisionFilters, DisableFiltersCheckBox);
         Control.AddOptionCheckBox(DCCVars.DisableGlimmerShader, DisableGlimmerEffectCheckBox);
+        Control.AddOptionCheckBox(DCCVars.ShowStunVisuals, EnableStunVisualsCheckBox);
         Control.AddOptionCheckBox(DCCVars.DisableTips, DisableTipsCheckBox);
 
         ResetTipsButton.OnPressed += _ => OnResetTipsPressed();

Content.Shared/_DV/CCVars/DCCVars.cs

@@ -130,6 +130,12 @@ public sealed partial class DCCVars
     public static readonly CVarDef<string> HiddenSpecies =
         CVarDef.Create("species.hidden", "Motorkind", CVar.SERVER | CVar.REPLICATED);
 
+    /// <summary>
+    /// Whether a stunned entity will show the stun visuals (seeing stars effect) above their head.
+    /// </summary>
+    public static readonly CVarDef<bool> ShowStunVisuals =
+        CVarDef.Create("game.see_stun_visuals", false, CVar.CLIENTONLY | CVar.ARCHIVE);
+
     /*
      * Traits
      */

Resources/Locale/en-US/_DV/escape-menu/options-menu.ftl

@@ -3,6 +3,7 @@ ui-options-general-forknotice = Note: These settings are fork-specific and might
 
 ui-options-no-filters = Disable species vision filters
 ui-options-disable-glimmer-effect = Disable high glimmer shader effect
+ui-options-enable-stun-visuals = Enable the 'Seeing Stars' effect on stunned entities
 
 ## DeltaV NanoChat keybinds
 ui-options-header-nano-chat = NanoChat

Resources/Prototypes/Entities/Mobs/NPCs/elemental.yml

@@ -39,7 +39,7 @@
         acts: [ "Destruction" ]
   - type: ZombieImmune
   - type: ProtectedFromStepTriggers
-  #- type: StunVisuals # DeltaV - No stars
+  - type: StunVisuals
 
 - type: entity
   abstract: true

Resources/Prototypes/Entities/Mobs/Species/base.yml

@@ -294,7 +294,7 @@
         Asphyxiation: -1.0
   - type: FireVisuals
     alternateState: Standing
-  #- type: StunVisuals # DeltaV - No stars
+  - type: StunVisuals
   - type: CanDoCPR # DeltaV - Addition of CPR
   - type: PotentialPsionic # DeltaV - organic species can all be psionic
   - type: RevealRevenantOnCollide # DeltaV - passing through people reveal revenant

Resources/Prototypes/Entities/Mobs/base.yml

@@ -39,7 +39,6 @@
   - type: RequireProjectileTarget
     active: False
   - type: AnimatedEmotes # goob edit - animated emotes
-  #- type: StunVisuals # DeltaV - No stars
 
 # The progenitor. This should only container the most basic components possible.
 # Only put things on here if every mob *must* have it. This includes ghosts.
@@ -112,7 +111,7 @@
       - !type:VomitBehavior
   - type: RadiationReceiver
   - type: Stamina
-  #- type: StunVisuals # DeltaV - No stars
+  - type: StunVisuals
   - type: MobState
   - type: MobThresholds
     thresholds: