Stagehand float animation

Content.Client/Movement/Systems/ClientSpriteMovementSystem.cs

@@ -1,45 +1,46 @@
 using Content.Shared.Movement.Components;
-using Content.Shared.Movement.Systems;
+using Content.Shared.Movement.Events;
 using Robust.Client.GameObjects;
 
 namespace Content.Client.Movement.Systems;
 
 /// <summary>
 /// Controls the switching of motion and standing still animation
 /// </summary>
-public sealed partial class ClientSpriteMovementSystem : SharedSpriteMovementSystem
+public sealed class ClientSpriteMovementSystem : VisualizerSystem<SpriteMovementComponent>
 {
-    [Dependency] private SpriteSystem _sprite = default!;
-
-    private EntityQuery<SpriteComponent> _spriteQuery;
-
-    public override void Initialize()
+    protected override void OnAppearanceChange(EntityUid uid, SpriteMovementComponent comp, ref AppearanceChangeEvent args)
     {
-        base.Initialize();
-
-        _spriteQuery = GetEntityQuery<SpriteComponent>();
-
-        SubscribeLocalEvent<SpriteMovementComponent, AfterAutoHandleStateEvent>(OnAfterAutoHandleState);
-    }
+        var sprite = args.Sprite;
+        if (!args.AppearanceData.TryGetValue(SpriteMovementVisuals.Moving, out var obj) || obj is not bool isMoving)
+            return;
 
-    private void OnAfterAutoHandleState(Entity<SpriteMovementComponent> ent, ref AfterAutoHandleStateEvent args)
-    {
-        if (!_spriteQuery.TryGetComponent(ent, out var sprite))
+        comp.WasMoving ??= !isMoving;
+        if (isMoving == comp.WasMoving)
             return;
 
-        if (ent.Comp.IsMoving)
-        {
-            foreach (var (layer, state) in ent.Comp.MovementLayers)
-            {
-                _sprite.LayerSetData((ent.Owner, sprite), layer, state);
-            }
-        }
-        else
+        void SetLayers(Dictionary<string, PrototypeLayerData> layers)
         {
-            foreach (var (layer, state) in ent.Comp.NoMovementLayers)
+            foreach (var (layer, state) in layers)
             {
-                _sprite.LayerSetData((ent.Owner, sprite), layer, state);
+                if (!SpriteSystem.TryGetLayer((uid, sprite), layer, out var layerData, true))
+                    continue;
+
+                var oldTime = layerData.AnimationTime;
+                var oldStateWasAnim = layerData.AnimationTimeLeft > 0;
+                SpriteSystem.LayerSetAutoAnimated(layerData, true);
+                SpriteSystem.LayerSetData(layerData, state);
+                // if there was old anim time left from a previously playing anim, take that into account here
+                if (oldStateWasAnim)
+                {
+                    var setAnimTime = layerData.AnimationTimeLeft - oldTime;
+                    SpriteSystem.LayerSetAnimationTime(layerData, setAnimTime);
+                }
             }
         }
+
+        Log.Info($"setting layers {isMoving}");
+        SetLayers(isMoving ? comp.MovementLayers : comp.NoMovementLayers);
+        comp.WasMoving = isMoving;
     }
 }

Content.Server/NPC/Systems/NPCSteeringSystem.cs

@@ -60,6 +60,7 @@ public sealed partial class NPCSteeringSystem : SharedNPCSteeringSystem
     [Dependency] private NpcFactionSystem _npcFaction = default!;
     [Dependency] private PathfindingSystem _pathfindingSystem = default!;
     [Dependency] private PryingSystem _pryingSystem = default!;
+    [Dependency] private SharedAppearanceSystem _appearance = default!;
     [Dependency] private SharedMapSystem _mapSystem = default!;
     [Dependency] private SharedInteractionSystem _interaction = default!;
     [Dependency] private SharedMeleeWeaponSystem _melee = default!;
@@ -216,8 +217,8 @@ public void Unregister(EntityUid uid, NPCSteeringComponent? component = null)
         {
             controller.CurTickSprintMovement = Vector2.Zero;
 
-            var ev = new SpriteMoveEvent(false);
-            RaiseLocalEvent(uid, ref ev);
+            if (controller.UsesSpriteMovement)
+                _appearance.SetData(uid, SpriteMovementVisuals.Moving, controller.HasDirectionalMovement);
         }
 
         component.PathfindToken?.Cancel();
@@ -297,8 +298,8 @@ private void SetDirection(EntityUid uid, InputMoverComponent component, NPCSteer
         component.LastInputTick = _timing.CurTick;
         component.LastInputSubTick = ushort.MaxValue;
 
-        var ev = new SpriteMoveEvent(true);
-        RaiseLocalEvent(uid, ref ev);
+        if (component.UsesSpriteMovement)
+            _appearance.SetData(uid, SpriteMovementVisuals.Moving, component.HasDirectionalMovement);
     }
 
     /// <summary>

Content.Shared/Gravity/FloatingVisualsComponent.cs

@@ -22,5 +22,11 @@ public sealed partial class FloatingVisualsComponent : Component
     [DataField, AutoNetworkedField]
     public bool CanFloat;
 
+    /// <summary>
+    /// If true, this sprite will always be floating irrespective of gravity status.
+    /// </summary>
+    [DataField, AutoNetworkedField]
+    public bool AlwaysFloat;
+
     public readonly string AnimationKey = "gravity";
 }

Content.Shared/Gravity/SharedFloatingVisualizerSystem.cs

@@ -25,7 +25,7 @@ public virtual void FloatAnimation(EntityUid uid, Vector2 offset, string animati
 
     protected bool CanFloat(Entity<FloatingVisualsComponent> entity)
     {
-        entity.Comp.CanFloat = _gravity.IsWeightless(entity.Owner);
+        entity.Comp.CanFloat = _gravity.IsWeightless(entity.Owner) || entity.Comp.AlwaysFloat;
         Dirty(entity);
         return entity.Comp.CanFloat;
     }
@@ -38,6 +38,9 @@ private void OnComponentStartup(Entity<FloatingVisualsComponent> entity, ref Com
 
     private void OnWeightlessnessChanged(Entity<FloatingVisualsComponent> entity, ref WeightlessnessChangedEvent args)
     {
+        if (entity.Comp.AlwaysFloat)
+            return;
+
         if (entity.Comp.CanFloat == args.Weightless)
             return;
 

Content.Shared/Movement/Components/InputMoverComponent.cs

@@ -83,6 +83,12 @@ public sealed partial class InputMoverComponent : Component
 
         [ViewVariables(VVAccess.ReadWrite)]
         public bool CanMove = true;
+
+        /// <summary>
+        ///     Used to optimize not changing movement appearance data if it isnt necessary.
+        /// </summary>
+        [DataField]
+        public bool UsesSpriteMovement = false;
     }
 
     [Serializable, NetSerializable]

Content.Shared/Movement/Components/SpriteMovementComponent.cs

@@ -5,7 +5,7 @@ namespace Content.Shared.Movement.Components;
 /// <summary>
 /// Updates a sprite layer based on whether an entity is moving via input or not.
 /// </summary>
-[RegisterComponent, NetworkedComponent, AutoGenerateComponentState(true)]
+[RegisterComponent, NetworkedComponent]
 public sealed partial class SpriteMovementComponent : Component
 {
     /// <summary>
@@ -20,6 +20,5 @@ public sealed partial class SpriteMovementComponent : Component
     [DataField]
     public Dictionary<string, PrototypeLayerData> NoMovementLayers = new();
 
-    [DataField, AutoNetworkedField]
-    public bool IsMoving;
+    public bool? WasMoving = null;
 }

Content.Shared/Movement/Events/SpriteMovementVisuals.cs

@@ -0,0 +1,9 @@
+using Robust.Shared.Serialization;
+
+namespace Content.Shared.Movement.Events;
+
+[Serializable, NetSerializable]
+public enum SpriteMovementVisuals : byte
+{
+    Moving,
+}

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

@@ -100,8 +100,8 @@ protected void SetMoveInput(Entity<InputMoverComponent> entity, MoveButtons butt
             RaiseLocalEvent(entity, ref moveEvent);
             Dirty(entity, entity.Comp);
 
-            var ev = new SpriteMoveEvent(entity.Comp.HasDirectionalMovement);
-            RaiseLocalEvent(entity, ref ev);
+            if (entity.Comp.UsesSpriteMovement)
+                _appearance.SetData(entity, SpriteMovementVisuals.Moving, entity.Comp.HasDirectionalMovement);
         }
 
         private void OnMoverHandleState(Entity<InputMoverComponent> entity, ref ComponentHandleState args)
@@ -126,8 +126,8 @@ private void OnMoverHandleState(Entity<InputMoverComponent> entity, ref Componen
                 entity.Comp.HeldMoveButtons = state.HeldMoveButtons;
                 RaiseLocalEvent(entity.Owner, ref moveEvent);
 
-                var ev = new SpriteMoveEvent(entity.Comp.HasDirectionalMovement);
-                RaiseLocalEvent(entity, ref ev);
+                if (entity.Comp.UsesSpriteMovement)
+                    _appearance.SetData(entity, SpriteMovementVisuals.Moving, entity.Comp.HasDirectionalMovement);
             }
         }
 

Content.Shared/Movement/Systems/SharedMoverController.cs

@@ -51,6 +51,7 @@ public abstract partial class SharedMoverController : VirtualController
     [Dependency] private SharedGravitySystem _gravity = default!;
     [Dependency] private SharedTransformSystem _transform = default!;
     [Dependency] private TagSystem _tags = default!;
+    [Dependency] private SharedAppearanceSystem _appearance = default!;
 
     protected EntityQuery<CanMoveInAirComponent> CanMoveInAirQuery;
     protected EntityQuery<FootstepModifierComponent> FootstepModifierQuery;

Resources/Prototypes/_ES/Entities/Markers/Spawners/jobs.yml

@@ -7,7 +7,7 @@
     sprite: Markers/jobs.rsi
     layers:
     - state: green
-    - sprite: _ES/Mobs/Ghosts/theatergoer.rsi
+    - sprite: _ES/Mobs/Ghosts/theatergoer_body.rsi
       state: body
   - type: SpawnPoint
     spawn_type: Theatergoer

Resources/Prototypes/_ES/Entities/Markers/lobby.yml

@@ -9,7 +9,7 @@
     sprite: Markers/cross.rsi
     layers:
     - state: green
-    - sprite: _ES/Mobs/Ghosts/theatergoer.rsi
+    - sprite: _ES/Mobs/Ghosts/theatergoer_head.rsi
       state: head-1
   - type: Physics
     bodyType: Static
@@ -36,7 +36,7 @@
     sprite: Markers/cross.rsi
     layers:
     - state: red
-    - sprite: _ES/Mobs/Ghosts/theatergoer.rsi
+    - sprite: _ES/Mobs/Ghosts/theatergoer_head.rsi
       state: head-3
   - type: Physics
     bodyType: Static

Resources/Prototypes/_ES/Entities/Mobs/Player/stagehand.yml

@@ -7,12 +7,13 @@
   description: Every show needs a loyal crew in the back making it tick. Today, that person is you.
   components:
   - type: Sprite
-    sprite: _ES/Mobs/Ghosts/theatergoer.rsi
+    sprite: _ES/Mobs/Ghosts/theatergoer_body.rsi
     layers:
     - state: body
       map: [ "body" ]
       shader: unshaded
     - state: head-1
+      sprite: _ES/Mobs/Ghosts/theatergoer_head.rsi
       map: [ "face" ]
       shader: unshaded
   - type: RandomSprite
@@ -69,9 +70,27 @@
   - type: GenericVisualizer
     visuals:
       enum.ESUsernameEntityVisuals.Admin:
-        base:
-          True: { state: admin, shader: unshaded }
-          False: { state: body, shader: unshaded }
+        body:
+          True:
+            sprite: _ES/Mobs/Ghosts/theatergoer_body_admin.rsi
+            loop: false
+          False:
+            sprite: _ES/Mobs/Ghosts/theatergoer_body.rsi
+            loop: false
+  - type: FloatingVisuals
+    offset: 0,0.1
+    alwaysFloat: true
+  - type: InputMover
+    usesSpriteMovement: true
+  - type: SpriteMovement
+    movementLayers:
+      body:
+        state: body-floating
+        loop: false
+    noMovementLayers:
+      body:
+        state: body-floating-reversed
+        loop: false
   - type: ESMindVisuals
   - type: ESBlockInteraction
   - type: ShowElectrocutionHUD

Resources/Prototypes/_ES/Entities/Mobs/Player/theatergoer.yml

@@ -5,11 +5,12 @@
   description: A member of your troupe.
   components:
   - type: Sprite
-    sprite: _ES/Mobs/Ghosts/theatergoer.rsi
+    sprite: _ES/Mobs/Ghosts/theatergoer_body.rsi
     layers:
     - state: body
       map: [ "body" ]
     - state: head-1
+      sprite: _ES/Mobs/Ghosts/theatergoer_head.rsi
       map: [ "face" ]
   - type: RandomSprite
     available:
@@ -46,9 +47,9 @@
   - type: GenericVisualizer
     visuals:
       enum.ESUsernameEntityVisuals.Admin:
-        base:
-          True: { state: admin }
-          False: { state: body }
+        body:
+          True: { sprite: _ES/Mobs/Ghosts/theatergoer_body_admin.rsi }
+          False: { sprite: _ES/Mobs/Ghosts/theatergoer_body.rsi }
   - type: ESMindVisuals
   - type: Buckle
   - type: Hands