Resolves PDAVisualizer is Obsolete (#13896)

Content.Client/PDA/PDASystem.cs

@@ -1,10 +1,34 @@
 using Content.Shared.PDA;
-using Robust.Shared.GameObjects;
+using Content.Shared.Light;
+using Robust.Client.GameObjects;
 
-namespace Content.Client.PDA
+namespace Content.Client.PDA;
+
+public sealed class PDASystem : SharedPDASystem
 {
-    public sealed class PDASystem : SharedPDASystem
+    public override void Initialize()
     {
-        // Nothing here. Have a lovely day.
+        base.Initialize();
+        SubscribeLocalEvent<PDAComponent, AppearanceChangeEvent>(OnAppearanceChange);
+    }
+
+    private void OnAppearanceChange(EntityUid uid, PDAComponent component, ref AppearanceChangeEvent args)
+    {
+        if (args.Sprite == null)
+            return;
+
+        args.Sprite.LayerSetState(PDAVisualLayers.Base, component.State);
+        if (_appearance.TryGetData<bool>(uid, UnpoweredFlashlightVisuals.LightOn, out var isFlashlightOn, args.Component))
+            args.Sprite.LayerSetVisible(PDAVisualLayers.Flashlight, isFlashlightOn);
+
+        if (_appearance.TryGetData<bool>(uid, PDAVisuals.IDCardInserted, out var isCardInserted, args.Component))
+            args.Sprite.LayerSetVisible(PDAVisualLayers.IDLight, isCardInserted);
     }
 }
+
+enum PDAVisualLayers : byte
+{
+    Base,
+    Flashlight,
+    IDLight
+}

Content.Client/PDA/PDAVisualizer.cs

@@ -1,65 +0,0 @@
-using Content.Shared.Light;
-using Content.Shared.PDA;
-using JetBrains.Annotations;
-using Robust.Client.GameObjects;
-using Robust.Shared.GameObjects;
-using Robust.Shared.IoC;
-using Robust.Shared.Serialization.Manager.Attributes;
-
-namespace Content.Client.PDA
-{
-    [UsedImplicitly]
-    // ReSharper disable once InconsistentNaming
-    public sealed class PDAVisualizer : AppearanceVisualizer
-    {
-        /// <summary>
-        /// The base PDA sprite state, eg. "pda", "pda-clown"
-        /// </summary>
-        [DataField("state")]
-        private string? _state;
-
-        private enum PDAVisualLayers : byte
-        {
-            Base,
-            Flashlight,
-            IDLight
-        }
-
-        [Obsolete("Subscribe to your component being initialised instead.")]
-        public override void InitializeEntity(EntityUid entity)
-        {
-            base.InitializeEntity(entity);
-            var entityManager = IoCManager.Resolve<IEntityManager>();
-            var sprite = entityManager.GetComponent<SpriteComponent>(entity);
-
-            if (_state != null)
-            {
-                sprite.LayerMapSet(PDAVisualLayers.Base, sprite.AddLayerState(_state));
-            }
-
-            sprite.LayerMapSet(PDAVisualLayers.Flashlight, sprite.AddLayerState("light_overlay"));
-            sprite.LayerSetShader(PDAVisualLayers.Flashlight, "unshaded");
-            sprite.LayerMapSet(PDAVisualLayers.IDLight, sprite.AddLayerState("id_overlay"));
-            sprite.LayerSetShader(PDAVisualLayers.IDLight, "unshaded");
-
-            var appearance = entityManager.GetComponent<PDAComponent>(entity);
-            sprite.LayerSetVisible(PDAVisualLayers.IDLight, appearance.IdSlot.StartingItem != null);
-        }
-
-        [Obsolete("Subscribe to AppearanceChangeEvent instead.")]
-        public override void OnChangeData(AppearanceComponent component)
-        {
-            base.OnChangeData(component);
-            var sprite = IoCManager.Resolve<IEntityManager>().GetComponent<SpriteComponent>(component.Owner);
-            sprite.LayerSetVisible(PDAVisualLayers.Flashlight, false);
-            if (component.TryGetData(UnpoweredFlashlightVisuals.LightOn, out bool isFlashlightOn))
-            {
-                sprite.LayerSetVisible(PDAVisualLayers.Flashlight, isFlashlightOn);
-            }
-            if (component.TryGetData(PDAVisuals.IDCardInserted, out bool isCardInserted))
-            {
-                sprite.LayerSetVisible(PDAVisualLayers.IDLight, isCardInserted);
-            }
-        }
-    }
-}

Content.Shared/PDA/PDAComponent.cs

@@ -11,6 +11,12 @@ namespace Content.Shared.PDA
         public const string PDAIdSlotId = "PDA-id";
         public const string PDAPenSlotId = "PDA-pen";
 
+        /// <summary>
+        /// The base PDA sprite state, eg. "pda", "pda-clown"
+        /// </summary>
+        [DataField("state")]
+        public string? State;
+
         [DataField("idSlot")]
         public ItemSlot IdSlot = new();
 

Content.Shared/PDA/SharedPDASystem.cs

@@ -7,7 +7,7 @@ namespace Content.Shared.PDA
     public abstract class SharedPDASystem : EntitySystem
     {
         [Dependency] protected readonly ItemSlotsSystem ItemSlotsSystem = default!;
-        [Dependency] private readonly SharedAppearanceSystem _appearance = default!;
+        [Dependency] protected readonly SharedAppearanceSystem _appearance = default!;
 
         public override void Initialize()
         {

Resources/Prototypes/Entities/Objects/Devices/pda.yml

@@ -6,15 +6,35 @@
   description: Personal Data Assistant.
   components:
   - type: Appearance
-    visuals:
-    - type: PDAVisualizer
-      state: pda
   - type: Sprite
     sprite: Objects/Devices/pda.rsi
-    netsync: false
+    layers:
+    - map: [ "enum.PDAVisualLayers.Base" ]
+    - map: [ "enum.PDAVisualLayers.Flashlight" ]
+      shader: "unshaded"
+      visible: false
+    - state: "id_overlay"
+      map: [ "enum.PDAVisualLayers.IDLight" ]
+      shader: "unshaded"
+      visible: false
   - type: Icon
     sprite: Objects/Devices/pda.rsi
     state: pda
+  - type: PDA
+    state: pda
+    penSlot:
+      startingItem: Pen
+      priority: -1
+      whitelist:
+        tags:
+        - Write
+    idSlot:
+      name: ID Card
+      ejectSound: /Audio/Machines/id_swipe.ogg
+      insertSound: /Audio/Weapons/Guns/MagIn/batrifle_magin.ogg
+      whitelist:
+        components:
+        - IdCard
   - type: Item
     size: 10
   - type: ContainerContainer
@@ -76,20 +96,6 @@
       type: InstrumentBoundUserInterface
     - key: enum.HealthAnalyzerUiKey.Key
       type: HealthAnalyzerBoundUserInterface
-  - type: PDA
-    penSlot:
-      startingItem: Pen
-      priority: -1
-      whitelist:
-        tags:
-        - Write
-    idSlot:
-      name: ID Card
-      ejectSound: /Audio/Machines/id_swipe.ogg
-      insertSound: /Audio/Weapons/Guns/MagIn/batrifle_magin.ogg
-      whitelist:
-        components:
-        - IdCard
   - type: CrewManifestViewer
     unsecure: true
   - type: Tag
@@ -106,6 +112,7 @@
   components:
   - type: PDA
     id: PassengerIDCard
+    state: pda
   - type: PDABorderColor
     borderColor: "#717059"
 
@@ -117,10 +124,7 @@
   components:
   - type: PDA
     id: TechnicalAssistantIDCard
-  - type: Appearance
+    state: pda-interntech
-    visuals:
-    - type: PDAVisualizer
-      state: pda-interntech
   - type: Icon
     state: pda-interntech
 
@@ -132,10 +136,7 @@
   components:
   - type: PDA
     id: MedicalInternIDCard
-  - type: Appearance
+    state: pda-internmed
-    visuals:
-    - type: PDAVisualizer
-      state: pda-internmed
   - type: Icon
     state: pda-internmed
   - type: HealthAnalyzer
@@ -151,10 +152,7 @@
   components:
   - type: PDA
     id: SecurityCadetIDCard
-  - type: Appearance
+    state: pda-interncadet
-    visuals:
-    - type: PDAVisualizer
-      state: pda-interncadet
   - type: Icon
     state: pda-interncadet
 
@@ -166,10 +164,7 @@
   components:
   - type: PDA
     id: ResearchAssistantIDCard
-  - type: Appearance
+    state: pda-internsci
-    visuals:
-    - type: PDAVisualizer
-      state: pda-internsci
   - type: Icon
     state: pda-internsci
 
@@ -181,10 +176,7 @@
   components:
   - type: PDA
     id: ServiceWorkerIDCard
-  - type: Appearance
+    state: pda-internservice
-    visuals:
-    - type: PDAVisualizer
-      state: pda-internservice
   - type: Icon
     state: pda-internservice
 
@@ -196,10 +188,7 @@
   components:
   - type: PDA
     id: ChefIDCard
-  - type: Appearance
+    state: pda-cook
-    visuals:
-    - type: PDAVisualizer
-      state: pda-cook
   - type: PDABorderColor
     borderColor: "#d7d7d0"
   - type: Icon
@@ -213,10 +202,7 @@
   components:
   - type: PDA
     id: BotanistIDCard
-  - type: Appearance
+    state: pda-hydro
-    visuals:
-      - type: PDAVisualizer
-        state: pda-hydro
   - type: Icon
     state: pda-hydro
 
@@ -228,6 +214,7 @@
   components:
   - type: PDA
     id: ClownIDCard
+    state: pda-clown
     penSlot:
       startingItem: CrayonOrange # no pink crayon?!?
       # ^ Still unacceptable.
@@ -236,10 +223,6 @@
       whitelist:
         tags:
         - Write
-  - type: Appearance
-    visuals:
-      - type: PDAVisualizer
-        state: pda-clown
   - type: PDABorderColor
     borderColor: "#C18199"
   - type: Icon
@@ -276,15 +259,12 @@
   components:
   - type: PDA
     id: MimeIDCard
+    state: pda-mime
     idSlot:
       name: ID Card
       whitelist:
         components:
         - IdCard
-  - type: Appearance
-    visuals:
-      - type: PDAVisualizer
-        state: pda-mime
   - type: Icon
     state: pda-mime
 
@@ -296,10 +276,7 @@
   components:
   - type: PDA
     id: ChaplainIDCard
-  - type: Appearance
+    state: pda-chaplain
-    visuals:
-      - type: PDAVisualizer
-        state: pda-chaplain
   - type: PDABorderColor
     borderColor: "#333333"
   - type: Icon
@@ -313,10 +290,7 @@
   components:
   - type: PDA
     id: QuartermasterIDCard
-  - type: Appearance
+    state: pda-qm
-    visuals:
-      - type: PDAVisualizer
-        state: pda-qm
   - type: Icon
     state: pda-qm
 
@@ -328,10 +302,7 @@
   components:
   - type: PDA
     id: CargoIDCard
-  - type: Appearance
+    state: pda-cargo
-    visuals:
-      - type: PDAVisualizer
-        state: pda-cargo
   - type: Icon
     state: pda-cargo
 
@@ -343,10 +314,7 @@
   components:
   - type: PDA
     id: SalvageIDCard
-  - type: Appearance
+    state: pda-miner
-    visuals:
-      - type: PDAVisualizer
-        state: pda-miner
   - type: Icon
     state: pda-miner
 
@@ -358,10 +326,7 @@
   components:
   - type: PDA
     id: BartenderIDCard
-  - type: Appearance
+    state: pda-bartender
-    visuals:
-      - type: PDAVisualizer
-        state: pda-bartender
   - type: Icon
     state: pda-bartender
 
@@ -373,10 +338,7 @@
   components:
   - type: PDA
     id: LibrarianIDCard
-  - type: Appearance
+    state: pda-library
-    visuals:
-      - type: PDAVisualizer
-        state: pda-library
   - type: Icon
     state: pda-library
 
@@ -388,10 +350,7 @@
   components:
   - type: PDA
     id: LawyerIDCard
-  - type: Appearance
+    state: pda-lawyer
-    visuals:
-      - type: PDAVisualizer
-        state: pda-lawyer
   - type: Icon
     state: pda-lawyer
 
@@ -403,10 +362,7 @@
   components:
   - type: PDA
     id: JanitorIDCard
-  - type: Appearance
+    state: pda-janitor
-    visuals:
-      - type: PDAVisualizer
-        state: pda-janitor
   - type: PDABorderColor
     borderColor: "#5D2D56"
   - type: Icon
@@ -420,16 +376,13 @@
   components:
   - type: PDA
     id: CaptainIDCard
+    state: pda-captain
     penSlot:
       startingItem: PenCap
       priority: -1
       whitelist:
         tags:
         - Write
-  - type: Appearance
-    visuals:
-      - type: PDAVisualizer
-        state: pda-captain
   - type: PDABorderColor
     borderColor: "#7C5D00"
   - type: Icon
@@ -443,16 +396,13 @@
   components:
   - type: PDA
     id: HoPIDCard
+    state: pda-hop
     penSlot:
       startingItem: PenHop
       priority: -1
       whitelist:
         tags:
         - Write
-  - type: Appearance
-    visuals:
-      - type: PDAVisualizer
-        state: pda-hop
   - type: Icon
     state: pda-hop
 
@@ -464,13 +414,11 @@
   components:
   - type: PDA
     id: CEIDCard
+    state: pda-ce
   - type: PDABorderColor
     borderColor: "#949137"
+    state: pda-ce
     accentHColor: "#447987"
-  - type: Appearance
-    visuals:
-      - type: PDAVisualizer
-        state: pda-ce
   - type: Icon
     state: pda-ce
 
@@ -482,10 +430,7 @@
   components:
   - type: PDA
     id: EngineeringIDCard
-  - type: Appearance
+    state: pda-engineer
-    visuals:
-      - type: PDAVisualizer
-        state: pda-engineer
   - type: Icon
     state: pda-engineer
 
@@ -497,10 +442,7 @@
   components:
   - type: PDA
     id: CMOIDCard
-  - type: Appearance
+    state: pda-cmo
-    visuals:
-      - type: PDAVisualizer
-        state: pda-cmo
   - type: PDABorderColor
     borderColor: "#d7d7d0"
     accentHColor: "#447987"
@@ -520,10 +462,7 @@
   components:
   - type: PDA
     id: MedicalIDCard
-  - type: Appearance
+    state: pda-medical
-    visuals:
-      - type: PDAVisualizer
-        state: pda-medical
   - type: PDABorderColor
     borderColor: "#d7d7d0"
     accentVColor: "#447987"
@@ -542,10 +481,7 @@
   components:
   - type: PDA
     id: ChemistIDCard
-  - type: Appearance
+    state: pda-chemistry
-    visuals:
-      - type: PDAVisualizer
-        state: pda-chemistry
   - type: PDABorderColor
     borderColor: "#d7d7d0"
     accentVColor: "#B34200"
@@ -560,10 +496,7 @@
   components:
   - type: PDA
     id: RDIDCard
-  - type: Appearance
+    state: pda-rd
-    visuals:
-      - type: PDAVisualizer
-        state: pda-rd
   - type: Icon
     state: pda-rd
 
@@ -575,10 +508,7 @@
   components:
   - type: PDA
     id: ResearchIDCard
-  - type: Appearance
+    state: pda-science
-    visuals:
-      - type: PDAVisualizer
-        state: pda-science
   - type: Icon
     state: pda-science
 
@@ -590,10 +520,7 @@
   components:
   - type: PDA
     id: HoSIDCard
-  - type: Appearance
+    state: pda-hos
-    visuals:
-      - type: PDAVisualizer
-        state: pda-hos
   - type: PDABorderColor
     borderColor: "#A32D26"
     accentHColor: "#447987"
@@ -608,10 +535,7 @@
   components:
   - type: PDA
     id: WardenIDCard
-  - type: Appearance
+    state: pda-warden
-    visuals:
-      - type: PDAVisualizer
-        state: pda-warden
   - type: Icon
     state: pda-warden
 
@@ -623,10 +547,7 @@
   components:
   - type: PDA
     id: SecurityIDCard
-  - type: Appearance
+    state: pda-security
-    visuals:
-      - type: PDAVisualizer
-        state: pda-security
   - type: Icon
     state: pda-security
 
@@ -638,6 +559,7 @@
   components:
   - type: PDA
     id: CentcomIDCardSyndie
+    state: pda
 
 - type: entity
   parent: BasePDA
@@ -647,10 +569,7 @@
   components:
   - type: PDA
     id: MusicianIDCard
-  - type: Appearance
+    state: pda-musician
-    visuals:
-    - type: PDAVisualizer
-      state: pda-musician
   - type: Instrument
     allowPercussion: false
     handheld: true
@@ -665,10 +584,7 @@
   components:
   - type: PDA
     id: AtmosIDCard
-  - type: Appearance
+    state: pda-atmos
-    visuals:
-      - type: PDAVisualizer
-        state: pda-atmos
   - type: Icon
     state: pda-atmos
 
@@ -680,10 +596,7 @@
   components:
   - type: PDA
     id: PassengerIDCard
-  - type: Appearance
+    state: pda-clear
-    visuals:
-      - type: PDAVisualizer
-        state: pda-clear
   - type: Icon
     state: pda-clear
 
@@ -695,10 +608,7 @@
   components:
   - type: PDA
     id: SyndicateIDCard
-  - type: Appearance
+    state: pda-syndi
-    visuals:
-      - type: PDAVisualizer
-        state: pda-syndi
   - type: Icon
     state: pda-syndi
 
@@ -710,13 +620,11 @@
   components:
   - type: PDA
     id: ERTLeaderIDCard
+    state: pda-ert
   - type: PDABorderColor
     borderColor: "#A32D26"
+    state: pda-ert
     accentHColor: "#447987"
-  - type: Appearance
-    visuals:
-    - type: PDAVisualizer
-      state: pda-ert
   - type: Icon
     state: pda-ert
 
@@ -728,6 +636,7 @@
   components:
   - type: PDA
     id: CBURNIDcard
+    state: pda-ert
   - type: PDABorderColor
     borderColor: "#A32D26"
     accentHColor: "#447987"
@@ -740,10 +649,7 @@
   components:
   - type: PDA
     id: PsychologistIDCard
-  - type: Appearance
+    state: pda-medical
-    visuals:
-      - type: PDAVisualizer
-        state: pda-medical
   - type: PDABorderColor
     borderColor: "#d7d7d0"
     accentVColor: "#447987"
@@ -758,10 +664,7 @@
   components:
   - type: PDA
     id: ReporterIDCard
-  - type: Appearance
+    state: pda-reporter
-    visuals:
-      - type: PDAVisualizer
-        state: pda-reporter
   - type: Icon
     state: pda-reporter
 
@@ -773,10 +676,7 @@
   components:
   - type: PDA
     id: ZookeeperIDCard
-  - type: Appearance
+    state: pda-zookeeper
-    visuals:
-      - type: PDAVisualizer
-        state: pda-zookeeper
   - type: Icon
     state: pda-zookeeper
 
@@ -788,10 +688,7 @@
   components:
   - type: PDA
     id: BoxerIDCard
-  - type: Appearance
+    state: pda-boxer
-    visuals:
-      - type: PDAVisualizer
-        state: pda-boxer
   - type: PDABorderColor
     borderColor: "#333333"
     borderVColor: "#390504"
@@ -806,10 +703,7 @@
   components:
   - type: PDA
     id: DetectiveIDCard
-  - type: Appearance
+    state: pda-detective
-    visuals:
-      - type: PDAVisualizer
-        state: pda-detective
   - type: PDABorderColor
     borderColor: "#774705"
   - type: Icon