Hotplate overhaul (#17586)

* Hotplate overhaul

- Beakers are now placed on top of the hotplate instead of itemslot.
- Hotplate LED now only lights up if it's heating something.
- More comments/xmldoc.
- Some other minor tweaks.

* Actually remove the beaker slot

Content.Server/Chemistry/Components/ActiveSolutionHeaterComponent.cs

@@ -3,5 +3,4 @@
 [RegisterComponent]
 public sealed class ActiveSolutionHeaterComponent : Component
 {
-
 }

Content.Server/Chemistry/Components/SolutionHeaterComponent.cs

@@ -1,19 +1,50 @@
-namespace Content.Server.Chemistry.Components;
+using Content.Shared.Whitelist;
+
+namespace Content.Server.Chemistry.Components;
 
 [RegisterComponent]
 public sealed class SolutionHeaterComponent : Component
 {
-    public readonly string BeakerSlotId = "beakerSlot";
-
-    [DataField("heatPerSecond")]
-    public float HeatPerSecond = 120;
+    /// <summary>
+    /// How much heat is added per second to the solution, with no upgrades.
+    /// </summary>
+    [DataField("baseHeatPerSecond")]
+    public float BaseHeatPerSecond = 120;
 
+    /// <summary>
+    /// How much heat is added per second to the solution, taking upgrades into account.
+    /// </summary>
     [ViewVariables(VVAccess.ReadWrite)]
-    public float HeatMultiplier = 1;
+    public float HeatPerSecond;
 
-    [DataField("machinePartHeatPerSecond")]
-    public string MachinePartHeatPerSecond = "Capacitor";
+    /// <summary>
+    /// The machine part that affects the heat multiplier.
+    /// </summary>
+    [DataField("machinePartHeatMultiplier")]
+    public string MachinePartHeatMultiplier = "Capacitor";
 
+    /// <summary>
+    /// How much each upgrade multiplies the heat by.
+    /// </summary>
     [DataField("partRatingHeatMultiplier")]
     public float PartRatingHeatMultiplier = 1.5f;
+
+    /// <summary>
+    /// The entities that are placed on the heater.
+    /// <summary>
+    [DataField("placedEntities")]
+    public HashSet<EntityUid> PlacedEntities = new();
+
+    /// <summary>
+    /// The max amount of entities that can be heated at the same time.
+    /// </summary>
+    [DataField("maxEntities")]
+    public uint MaxEntities = 1;
+
+    /// <summary>
+    /// Whitelist for entities that can be placed on the heater.
+    /// </summary>
+    [DataField("whitelist")]
+    [ViewVariables(VVAccess.ReadWrite)]
+    public EntityWhitelist? Whitelist;
 }

Content.Server/Chemistry/EntitySystems/SolutionHeaterSystem.cs

@@ -1,14 +1,22 @@
-using Content.Server.Chemistry.Components;
+using System.Linq;
+using Content.Server.Chemistry.Components;
 using Content.Server.Chemistry.Components.SolutionManager;
 using Content.Server.Construction;
 using Content.Server.Power.Components;
-using Content.Shared.Containers.ItemSlots;
+using Content.Server.Power.EntitySystems;
+using Content.Shared.Chemistry;
+using Content.Shared.Placeable;
+using Robust.Shared.Physics.Events;
+using Robust.Shared.Physics.Systems;
 
 namespace Content.Server.Chemistry.EntitySystems;
 
 public sealed class SolutionHeaterSystem : EntitySystem
 {
-    [Dependency] private readonly ItemSlotsSystem _itemSlots = default!;
+    [Dependency] private readonly SharedAppearanceSystem _appearance = default!;
+    [Dependency] private readonly SharedPhysicsSystem _physics = default!;
+    [Dependency] private readonly PlaceableSurfaceSystem _placeableSurface = default!;
+    [Dependency] private readonly PowerReceiverSystem _powerReceiver = default!;
     [Dependency] private readonly SolutionContainerSystem _solution = default!;
 
     /// <inheritdoc/>
@@ -17,48 +25,101 @@ public sealed class SolutionHeaterSystem : EntitySystem
         SubscribeLocalEvent<SolutionHeaterComponent, PowerChangedEvent>(OnPowerChanged);
         SubscribeLocalEvent<SolutionHeaterComponent, RefreshPartsEvent>(OnRefreshParts);
         SubscribeLocalEvent<SolutionHeaterComponent, UpgradeExamineEvent>(OnUpgradeExamine);
+        SubscribeLocalEvent<SolutionHeaterComponent, StartCollideEvent>(OnStartCollide);
+        SubscribeLocalEvent<SolutionHeaterComponent, EndCollideEvent>(OnEndCollide);
+    }
+
+    private void TurnOn(EntityUid uid)
+    {
+        _appearance.SetData(uid, SolutionHeaterVisuals.IsOn, true);
+        EnsureComp<ActiveSolutionHeaterComponent>(uid);
+    }
+
+    public bool TryTurnOn(EntityUid uid, SolutionHeaterComponent component)
+    {
+        if (component.PlacedEntities.Count <= 0 || !_powerReceiver.IsPowered(uid))
+            return false;
+
+        TurnOn(uid);
+        return true;
+    }
+
+    public void TurnOff(EntityUid uid)
+    {
+        _appearance.SetData(uid, SolutionHeaterVisuals.IsOn, false);
+        RemComp<ActiveSolutionHeaterComponent>(uid);
     }
 
     private void OnPowerChanged(EntityUid uid, SolutionHeaterComponent component, ref PowerChangedEvent args)
     {
-        if (args.Powered)
+        if (args.Powered && component.PlacedEntities.Count > 0)
         {
-            EnsureComp<ActiveSolutionHeaterComponent>(uid);
+            TurnOn(uid);
         }
         else
         {
-            RemComp<ActiveSolutionHeaterComponent>(uid);
+            TurnOff(uid);
         }
     }
 
     private void OnRefreshParts(EntityUid uid, SolutionHeaterComponent component, RefreshPartsEvent args)
     {
-        var heatRating = args.PartRatings[component.MachinePartHeatPerSecond] - 1;
+        var heatRating = args.PartRatings[component.MachinePartHeatMultiplier] - 1;
 
-        component.HeatMultiplier = MathF.Pow(component.PartRatingHeatMultiplier, heatRating);
+        component.HeatPerSecond = component.BaseHeatPerSecond * MathF.Pow(component.PartRatingHeatMultiplier, heatRating);
     }
 
     private void OnUpgradeExamine(EntityUid uid, SolutionHeaterComponent component, UpgradeExamineEvent args)
     {
-        args.AddPercentageUpgrade("solution-heater-upgrade-heat", component.HeatMultiplier);
+        args.AddPercentageUpgrade("solution-heater-upgrade-heat", component.HeatPerSecond / component.BaseHeatPerSecond);
+    }
+
+    private void OnStartCollide(EntityUid uid, SolutionHeaterComponent component, ref StartCollideEvent args)
+    {
+        if (component.Whitelist is not null && !component.Whitelist.IsValid(args.OtherEntity))
+            return;
+
+        // Disallow sleeping so we can detect when entity is removed from the heater.
+        _physics.SetSleepingAllowed(args.OtherEntity, args.OtherBody, false);
+
+        component.PlacedEntities.Add(args.OtherEntity);
+
+        TryTurnOn(uid, component);
+
+        if (component.PlacedEntities.Count >= component.MaxEntities)
+            _placeableSurface.SetPlaceable(uid, false);
+    }
+
+    private void OnEndCollide(EntityUid uid, SolutionHeaterComponent component, ref EndCollideEvent args)
+    {
+        // Re-allow sleeping.
+        _physics.SetSleepingAllowed(args.OtherEntity, args.OtherBody, true);
+
+        component.PlacedEntities.Remove(args.OtherEntity);
+
+        if (component.PlacedEntities.Count == 0) // Last entity was removed
+            TurnOff(uid);
+
+        _placeableSurface.SetPlaceable(uid, true);
     }
 
     public override void Update(float frameTime)
     {
         base.Update(frameTime);
 
-        foreach (var (_, heater) in EntityQuery<ActiveSolutionHeaterComponent, SolutionHeaterComponent>())
+        var query = EntityQueryEnumerator<ActiveSolutionHeaterComponent, SolutionHeaterComponent>();
+        while (query.MoveNext(out _, out _, out var heater))
         {
-            if (_itemSlots.GetItemOrNull(heater.Owner, heater.BeakerSlotId) is not { } item)
-                continue;
-
-            if (!TryComp<SolutionContainerManagerComponent>(item, out var solution))
-                continue;
-
-            var energy = heater.HeatPerSecond * heater.HeatMultiplier * frameTime;
-            foreach (var s in solution.Solutions.Values)
+            foreach (var heatingEntity in heater.PlacedEntities.Take((int) heater.MaxEntities))
             {
-                _solution.AddThermalEnergy(solution.Owner, s, energy);
+                if (!TryComp<SolutionContainerManagerComponent>(heatingEntity, out var solution))
+                    continue;
+
+                var energy = heater.HeatPerSecond * frameTime;
+                foreach (var s in solution.Solutions.Values)
+                {
+                    _solution.AddThermalEnergy(heatingEntity, s, energy);
+                }
             }
         }
     }

Content.Shared/Chemistry/SharedSolutionHeater.cs

@@ -0,0 +1,9 @@
+using Robust.Shared.Serialization;
+
+namespace Content.Shared.Chemistry;
+
+[Serializable, NetSerializable]
+public enum SolutionHeaterVisuals
+{
+    IsOn,
+}

Resources/Prototypes/Entities/Structures/Machines/hotplate.yml

@@ -15,7 +15,10 @@
         mask:
         - TabletopMachineMask
         layer:
-        - TabletopMachineLayer
+        - Impassable
+        - MidImpassable
+        - LowImpassable
+        hard: false
   - type: Sprite
     sprite: Structures/Machines/hotplate.rsi
     drawdepth: SmallObjects
@@ -23,16 +26,10 @@
     layers:
     - state: icon
     - state: on
-      map: ["enum.PowerDeviceVisualLayers.Powered"]
+      map: ["enum.SolutionHeaterVisuals.IsOn"]
       shader: unshaded
   - type: ApcPowerReceiver
     powerLoad: 300
-  - type: ItemSlots
-    slots:
-      beakerSlot:
-        whitelist:
-          components:
-          - FitsInDispenser
   - type: ItemMapper
     sprite: Structures/Machines/hotplate.rsi
     mapLayers:
@@ -41,17 +38,22 @@
           components:
           - FitsInDispenser
   - type: SolutionHeater
+    whitelist:
+      components:
+      - FitsInDispenser
+  - type: PlaceableSurface
+    placeCentered: true
+    positionOffset: 0, 0.25
   - type: Machine
     board: HotplateMachineCircuitboard
   - type: Appearance
   - type: ContainerContainer
     containers:
-      beakerSlot: !type:ContainerSlot
       machine_board: !type:Container
       machine_parts: !type:Container
   - type: GenericVisualizer
     visuals:
-      enum.PowerDeviceVisuals.Powered:
-        enum.PowerDeviceVisualLayers.Powered:
+      enum.SolutionHeaterVisuals.IsOn:
+        enum.SolutionHeaterVisuals.IsOn:
           True: { visible: true }
           False: { visible: false }