Display an Alert when the User Is Walking or Running. (#528)

# Description

First PR. Adds an alert on the user UI whenever they toggle between
walking or running. No more second guessing whether you will slip or not
when walking over that puddle of water, or if your usage of Shift on
chat toggled your movement speed.

The alert is displayed for entities with the component
'CanWalkComponent', which is added to the following prototypes:
- All genetic ancestors (MobBaseAncestor)
- Human controlled mechs (BaseMech, wont display on VIMs or HAMTRs
because rats or hamsters can't walk, and the edge case is not worth the
trouble)
- All human/player species (BaseMobSpeciesOrganic)
- All slimes/geras (BaseMobAdultSlimes)
- Reagent Slimes (ReagentSlime)
- Rat Kings (MobRatKing - yes they can fucking walk lmao)
- Borgs (BaseBorgChassis)
---
<details><summary><h1>Media</h1></summary>
<p>


https://github.com/Simple-Station/Einstein-Engines/assets/159397573/1a60711b-d048-444d-bd08-6a9eadeccc8a


</p>
</details>

---

# Future Stuff

I also wanted to make it toggle the user's speed on click like it would
in ss13, but sadly the majority of the input management/prediction seems
to be done exclusively client-side, making it a hassle to work around
the alert. **Will revisit if there's improvements or refactors to the
movement code.**

---

# Changelog

:cl:
- add: Added an alert on the UI for when the user is walking or running.

---------

Signed-off-by: gluesniffler <[email protected]>
Co-authored-by: DEATHB4DEFEAT <[email protected]>

Content.Shared/Alert/AlertType.cs

@@ -37,6 +37,7 @@ public enum AlertType : byte
         Internals,
         Toxins,
         Muted,
+        Walking,
         VowOfSilence,
         VowBroken,
         Essence,

Content.Shared/Movement/Components/CanWalkComponent.cs

@@ -0,0 +1,11 @@
+using Robust.Shared.GameStates;
+
+namespace Content.Shared.Movement.Components;
+
+/// <summary>
+/// Indicates if the entity can toggle walking or not.
+/// </summary>
+[NetworkedComponent, RegisterComponent]
+public sealed partial class CanWalkComponent : Component
+{
+}

Content.Shared/Movement/Components/InputMoverComponent.cs

@@ -1,9 +1,11 @@
 using System.Numerics;
+using Content.Shared.Alert;
 using Content.Shared.Movement.Systems;
 using Robust.Shared.GameStates;
 using Robust.Shared.Serialization;
 using Robust.Shared.Serialization.TypeSerializers.Implementations.Custom;
 using Robust.Shared.Timing;
+using Robust.Shared.Prototypes;
 
 namespace Content.Shared.Movement.Components
 {
@@ -74,6 +76,9 @@ public sealed partial class InputMoverComponent : Component
 
         [ViewVariables(VVAccess.ReadWrite)]
         public bool CanMove = true;
+
+        [DataField]
+        public ProtoId<AlertPrototype> WalkingAlert = "Walking";
     }
 
     [Serializable, NetSerializable]

Content.Shared/Movement/Systems/SharedMoverController.Input.cs

@@ -1,4 +1,5 @@
 using System.Numerics;
+using Content.Shared.Alert;
 using Content.Shared.CCVar;
 using Content.Shared.Follower.Components;
 using Content.Shared.Input;
@@ -333,6 +334,7 @@ private void OnInputInit(EntityUid uid, InputMoverComponent component, Component
 
             component.RelativeEntity = xform.GridUid ?? xform.MapUid;
             component.TargetRelativeRotation = Angle.Zero;
+            WalkingAlert(uid, !component.Sprinting);
         }
 
         private void HandleRunChange(EntityUid uid, ushort subTick, bool walking)
@@ -344,6 +346,7 @@ private void HandleRunChange(EntityUid uid, ushort subTick, bool walking)
                 // if we swap to relay then stop our existing input if we ever change back.
                 if (moverComp != null)
                 {
+                    WalkingAlert(uid, walking);
                     SetMoveInput(moverComp, MoveButtons.None);
                 }
 
@@ -460,10 +463,11 @@ private void ResetSubtick(InputMoverComponent component)
             component.LastInputSubTick = 0;
         }
 
+
         public void SetSprinting(EntityUid entity, InputMoverComponent component, ushort subTick, bool walking)
         {
             // Logger.Info($"[{_gameTiming.CurTick}/{subTick}] Sprint: {enabled}");
-
+            WalkingAlert(entity, walking);
             SetMoveInput(entity, component, subTick, walking, MoveButtons.Walk);
         }
 

Content.Shared/Movement/Systems/SharedMoverController.cs

@@ -1,5 +1,6 @@
 using System.Diagnostics.CodeAnalysis;
 using System.Numerics;
+using Content.Shared.Alert;
 using Content.Shared.Bed.Sleep;
 using Content.Shared.CCVar;
 using Content.Shared.Friction;
@@ -25,6 +26,7 @@
 using Robust.Shared.Utility;
 using PullableComponent = Content.Shared.Movement.Pulling.Components.PullableComponent;
 
+
 namespace Content.Shared.Movement.Systems
 {
     /// <summary>
@@ -33,6 +35,7 @@ namespace Content.Shared.Movement.Systems
     /// </summary>
     public abstract partial class SharedMoverController : VirtualController
     {
+        [Dependency] private   readonly AlertsSystem _alerts = default!;
         [Dependency] private   readonly IConfigurationManager _configManager = default!;
         [Dependency] protected readonly IGameTiming Timing = default!;
         [Dependency] private   readonly IMapManager _mapManager = default!;
@@ -165,6 +168,7 @@ protected void HandleMobMovement(
             var (walkDir, sprintDir) = GetVelocityInput(mover);
             var touching = false;
 
+
             // Handle wall-pushes.
             if (weightless)
             {
@@ -285,6 +289,14 @@ protected void HandleMobMovement(
             PhysicsSystem.SetAngularVelocity(physicsUid, 0, body: physicsComponent);
         }
 
+        public void WalkingAlert(EntityUid player, bool walking)
+        {
+            if (HasComp<CanWalkComponent>(player))
+            {
+                _alerts.ShowAlert(player, AlertType.Walking, walking ? (short) 0 : (short) 1);
+            }
+        }
+
         public void LerpRotation(EntityUid uid, InputMoverComponent mover, float frameTime)
         {
             var angleDiff = Angle.ShortestDistance(mover.RelativeRotation, mover.TargetRelativeRotation);

Resources/Locale/en-US/alerts/alerts.ftl

@@ -111,5 +111,8 @@ alerts-revenant-essence-desc = The power of souls. It sustains you and is used f
 alerts-revenant-corporeal-name = Corporeal
 alerts-revenant-corporeal-desc = You have manifested physically. People around you can see and hurt you.
 
+alerts-walking-name = Walking
+alerts-walking-desc = Indicates how fast you're moving.
+
 alerts-offer-name = Offer
 alerts-offer-desc = Someone offers you an item.

Resources/Prototypes/Alerts/alerts.yml

@@ -429,6 +429,18 @@
   name: alerts-pacified-name
   description: alerts-pacified-desc
 
+- type: alert
+  id: Walking
+  icons:
+  - sprite: /Textures/Interface/Alerts/walking.rsi
+    state: walking0
+  - sprite: /Textures/Interface/Alerts/walking.rsi
+    state: walking1
+  name: alerts-walking-name
+  description: alerts-walking-desc
+  minSeverity: 0
+  maxSeverity: 1
+
 - type: alert
   id: Debug1
   icons:

Resources/Prototypes/Entities/Mobs/Cyborgs/base_borg_chassis.yml

@@ -220,6 +220,7 @@
     understands:
     - GalacticCommon
     - RobotTalk
+  - type: CanWalk
 
 - type: entity
   id: BaseBorgChassisNT

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

@@ -1309,6 +1309,7 @@
     tags:
     - VimPilot
     - DoorBumpOpener
+  - type: CanWalk
 
 - type: entity
   name: monkey

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

@@ -292,6 +292,7 @@
     solution: bloodstream
   - type: DrainableSolution
     solution: bloodstream
+  - type: CanWalk
 
 - type: entity
   name: Reagent Slime Spawner

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

@@ -126,6 +126,7 @@
     understands:
     - GalacticCommon
     - Mouse
+  - type: CanWalk
 
 - type: entity
   id: MobRatKingBuff

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

@@ -128,6 +128,7 @@
     speechSounds: Slime
   - type: TypingIndicator
     proto: slime
+  - type: CanWalk
 
 - type: entity
   name: blue slime

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

@@ -229,6 +229,7 @@
     - CanPilot
     - FootstepSound
     - DoorBumpOpener
+  - type: CanWalk
 
 - type: entity
   save: false

Resources/Prototypes/Entities/Objects/Specific/Mech/mechs.yml

@@ -95,6 +95,7 @@
   - type: GuideHelp
     guides:
     - Robotics
+  - type: CanWalk
 
 - type: entity
   id: MechRipley

Resources/Textures/Interface/Alerts/walking.rsi/meta.json

@@ -0,0 +1,17 @@
+{
+    "version": 1,
+    "license": "CC-BY-SA-3.0",
+    "copyright": "Walking/Running icons modified by Mocho, original taken from /tg/station https://github.com/tgstation/tgstation/pull/52691/commits/6a1261187c108c8f151c99ebfa567bd1ec34044c",
+    "size": {
+        "x": 32,
+        "y": 32
+    },
+    "states": [
+        {
+            "name": "walking0"
+        },
+        {
+            "name": "walking1"
+        }
+    ]
+}