scoopable ash and foam, solution transfer prediction (#25832)

* move SolutionTransfer to shared and predict as much as possible

* fully move OpenableSystem to shared now that SolutionTransfer is

* fix imports for everything

* doc for solution transfer system

* trolling

* add scoopable system

* make ash and foam scoopable

* untroll

* untroll real

* make clickable it work

* troll

* the scooping room

---------

Co-authored-by: deltanedas <@deltanedas:kde.org>
Co-authored-by: metalgearsloth <comedian_vs_clown@hotmail.com>

Content.Server/Chemistry/EntitySystems/ReagentDispenserSystem.cs

@@ -1,11 +1,12 @@
 using Content.Server.Chemistry.Components;
 using Content.Server.Chemistry.Containers.EntitySystems;
-using Content.Server.Nutrition.EntitySystems;
+using Content.Server.Nutrition.Components;
 using Content.Shared.Chemistry;
 using Content.Shared.Chemistry.Dispenser;
 using Content.Shared.Chemistry.EntitySystems;
 using Content.Shared.Containers.ItemSlots;
 using Content.Shared.FixedPoint;
+using Content.Shared.Nutrition.EntitySystems;
 using JetBrains.Annotations;
 using Robust.Server.Audio;
 using Robust.Server.GameObjects;

Content.Server/Chemistry/EntitySystems/SolutionTransferSystem.cs

@@ -1,234 +0,0 @@
-using Content.Server.Administration.Logs;
-using Content.Server.Chemistry.Containers.EntitySystems;
-using Content.Shared.Chemistry;
-using Content.Shared.Chemistry.Components;
-using Content.Shared.Database;
-using Content.Shared.FixedPoint;
-using Content.Shared.Interaction;
-using Content.Shared.Popups;
-using Content.Shared.Verbs;
-using JetBrains.Annotations;
-using Robust.Server.GameObjects;
-using Robust.Shared.Player;
-
-namespace Content.Server.Chemistry.EntitySystems
-{
-    [UsedImplicitly]
-    public sealed class SolutionTransferSystem : EntitySystem
-    {
-        [Dependency] private readonly SharedPopupSystem _popupSystem = default!;
-        [Dependency] private readonly SolutionContainerSystem _solutionContainerSystem = default!;
-        [Dependency] private readonly UserInterfaceSystem _userInterfaceSystem = default!;
-        [Dependency] private readonly IAdminLogManager _adminLogger = default!;
-
-        /// <summary>
-        ///     Default transfer amounts for the set-transfer verb.
-        /// </summary>
-        public static readonly List<int> DefaultTransferAmounts = new() { 1, 5, 10, 25, 50, 100, 250, 500, 1000 };
-
-        public override void Initialize()
-        {
-            base.Initialize();
-
-            SubscribeLocalEvent<SolutionTransferComponent, GetVerbsEvent<AlternativeVerb>>(AddSetTransferVerbs);
-            SubscribeLocalEvent<SolutionTransferComponent, AfterInteractEvent>(OnAfterInteract);
-            SubscribeLocalEvent<SolutionTransferComponent, TransferAmountSetValueMessage>(OnTransferAmountSetValueMessage);
-        }
-
-        private void OnTransferAmountSetValueMessage(Entity<SolutionTransferComponent> entity, ref TransferAmountSetValueMessage message)
-        {
-            var newTransferAmount = FixedPoint2.Clamp(message.Value, entity.Comp.MinimumTransferAmount, entity.Comp.MaximumTransferAmount);
-            entity.Comp.TransferAmount = newTransferAmount;
-
-            if (message.Session.AttachedEntity is { Valid: true } user)
-                _popupSystem.PopupEntity(Loc.GetString("comp-solution-transfer-set-amount", ("amount", newTransferAmount)), entity.Owner, user);
-        }
-
-        private void AddSetTransferVerbs(Entity<SolutionTransferComponent> entity, ref GetVerbsEvent<AlternativeVerb> args)
-        {
-            var (uid, component) = entity;
-
-            if (!args.CanAccess || !args.CanInteract || !component.CanChangeTransferAmount || args.Hands == null)
-                return;
-
-            if (!EntityManager.TryGetComponent(args.User, out ActorComponent? actor))
-                return;
-
-            // Custom transfer verb
-            AlternativeVerb custom = new();
-            custom.Text = Loc.GetString("comp-solution-transfer-verb-custom-amount");
-            custom.Category = VerbCategory.SetTransferAmount;
-            custom.Act = () => _userInterfaceSystem.TryOpen(uid, TransferAmountUiKey.Key, actor.PlayerSession);
-            custom.Priority = 1;
-            args.Verbs.Add(custom);
-
-            // Add specific transfer verbs according to the container's size
-            var priority = 0;
-            var user = args.User;
-            foreach (var amount in DefaultTransferAmounts)
-            {
-                if (amount < component.MinimumTransferAmount.Int() || amount > component.MaximumTransferAmount.Int())
-                    continue;
-
-                AlternativeVerb verb = new();
-                verb.Text = Loc.GetString("comp-solution-transfer-verb-amount", ("amount", amount));
-                verb.Category = VerbCategory.SetTransferAmount;
-                verb.Act = () =>
-                {
-                    component.TransferAmount = FixedPoint2.New(amount);
-                    _popupSystem.PopupEntity(Loc.GetString("comp-solution-transfer-set-amount", ("amount", amount)), uid, user);
-                };
-
-                // we want to sort by size, not alphabetically by the verb text.
-                verb.Priority = priority;
-                priority--;
-
-                args.Verbs.Add(verb);
-            }
-        }
-
-        private void OnAfterInteract(Entity<SolutionTransferComponent> entity, ref AfterInteractEvent args)
-        {
-            if (!args.CanReach || args.Target == null)
-                return;
-
-            var target = args.Target!.Value;
-            var (uid, component) = entity;
-
-            //Special case for reagent tanks, because normally clicking another container will give solution, not take it.
-            if (component.CanReceive && !EntityManager.HasComponent<RefillableSolutionComponent>(target) // target must not be refillable (e.g. Reagent Tanks)
-                                     && _solutionContainerSystem.TryGetDrainableSolution(target, out var targetSoln, out _) // target must be drainable
-                                     && EntityManager.TryGetComponent(uid, out RefillableSolutionComponent? refillComp)
-                                     && _solutionContainerSystem.TryGetRefillableSolution((uid, refillComp, null), out var ownerSoln, out var ownerRefill))
-
-            {
-
-                var transferAmount = component.TransferAmount; // This is the player-configurable transfer amount of "uid," not the target reagent tank.
-
-                if (EntityManager.TryGetComponent(uid, out RefillableSolutionComponent? refill) && refill.MaxRefill != null) // uid is the entity receiving solution from target.
-                {
-                    transferAmount = FixedPoint2.Min(transferAmount, (FixedPoint2) refill.MaxRefill); // if the receiver has a smaller transfer limit, use that instead
-                }
-
-                var transferred = Transfer(args.User, target, targetSoln.Value, uid, ownerSoln.Value, transferAmount);
-                if (transferred > 0)
-                {
-                    var toTheBrim = ownerRefill.AvailableVolume == 0;
-                    var msg = toTheBrim
-                        ? "comp-solution-transfer-fill-fully"
-                        : "comp-solution-transfer-fill-normal";
-
-                    _popupSystem.PopupEntity(Loc.GetString(msg, ("owner", args.Target), ("amount", transferred), ("target", uid)), uid, args.User);
-
-                    args.Handled = true;
-                    return;
-                }
-            }
-
-            // if target is refillable, and owner is drainable
-            if (component.CanSend && _solutionContainerSystem.TryGetRefillableSolution(target, out targetSoln, out var targetRefill)
-                                  && _solutionContainerSystem.TryGetDrainableSolution(uid, out ownerSoln, out var ownerDrain))
-            {
-                var transferAmount = component.TransferAmount;
-
-                if (EntityManager.TryGetComponent(target, out RefillableSolutionComponent? refill) && refill.MaxRefill != null)
-                {
-                    transferAmount = FixedPoint2.Min(transferAmount, (FixedPoint2) refill.MaxRefill);
-                }
-
-                var transferred = Transfer(args.User, uid, ownerSoln.Value, target, targetSoln.Value, transferAmount);
-
-                if (transferred > 0)
-                {
-                    var message = Loc.GetString("comp-solution-transfer-transfer-solution", ("amount", transferred), ("target", target));
-                    _popupSystem.PopupEntity(message, uid, args.User);
-
-                    args.Handled = true;
-                }
-            }
-        }
-
-        /// <summary>
-        /// Transfer from a solution to another.
-        /// </summary>
-        /// <returns>The actual amount transferred.</returns>
-        public FixedPoint2 Transfer(EntityUid user,
-            EntityUid sourceEntity,
-            Entity<SolutionComponent> source,
-            EntityUid targetEntity,
-            Entity<SolutionComponent> target,
-            FixedPoint2 amount)
-        {
-            var transferAttempt = new SolutionTransferAttemptEvent(sourceEntity, targetEntity);
-
-            // Check if the source is cancelling the transfer
-            RaiseLocalEvent(sourceEntity, transferAttempt, broadcast: true);
-            if (transferAttempt.Cancelled)
-            {
-                _popupSystem.PopupEntity(transferAttempt.CancelReason!, sourceEntity, user);
-                return FixedPoint2.Zero;
-            }
-
-            var sourceSolution = source.Comp.Solution;
-            if (sourceSolution.Volume == 0)
-            {
-                _popupSystem.PopupEntity(Loc.GetString("comp-solution-transfer-is-empty", ("target", sourceEntity)), sourceEntity, user);
-                return FixedPoint2.Zero;
-            }
-
-            // Check if the target is cancelling the transfer
-            RaiseLocalEvent(targetEntity, transferAttempt, broadcast: true);
-            if (transferAttempt.Cancelled)
-            {
-                _popupSystem.PopupEntity(transferAttempt.CancelReason!, sourceEntity, user);
-                return FixedPoint2.Zero;
-            }
-
-            var targetSolution = target.Comp.Solution;
-            if (targetSolution.AvailableVolume == 0)
-            {
-                _popupSystem.PopupEntity(Loc.GetString("comp-solution-transfer-is-full", ("target", targetEntity)), targetEntity, user);
-                return FixedPoint2.Zero;
-            }
-
-            var actualAmount = FixedPoint2.Min(amount, FixedPoint2.Min(sourceSolution.Volume, targetSolution.AvailableVolume));
-
-            var solution = _solutionContainerSystem.Drain(sourceEntity, source, actualAmount);
-            _solutionContainerSystem.Refill(targetEntity, target, solution);
-
-            _adminLogger.Add(LogType.Action, LogImpact.Medium,
-                $"{EntityManager.ToPrettyString(user):player} transferred {string.Join(", ", solution.Contents)} to {EntityManager.ToPrettyString(targetEntity):entity}, which now contains {SolutionContainerSystem.ToPrettyString(targetSolution)}");
-
-            return actualAmount;
-        }
-    }
-
-    /// <summary>
-    /// Raised when attempting to transfer from one solution to another.
-    /// </summary>
-    public sealed class SolutionTransferAttemptEvent : CancellableEntityEventArgs
-    {
-        public SolutionTransferAttemptEvent(EntityUid from, EntityUid to)
-        {
-            From = from;
-            To = to;
-        }
-
-        public EntityUid From { get; }
-        public EntityUid To { get; }
-
-        /// <summary>
-        /// Why the transfer has been cancelled.
-        /// </summary>
-        public string? CancelReason { get; private set; }
-
-        /// <summary>
-        /// Cancels the transfer.
-        /// </summary>
-        public void Cancel(string reason)
-        {
-            base.Cancel();
-            CancelReason = reason;
-        }
-    }
-}

Content.Server/Destructible/Thresholds/Behaviors/OpenBehavior.cs

@@ -1,4 +1,4 @@
-using Content.Server.Nutrition.EntitySystems;
+using Content.Shared.Nutrition.EntitySystems;
 
 namespace Content.Server.Destructible.Thresholds.Behaviors;
 

Content.Server/Extinguisher/FireExtinguisherSystem.cs

@@ -73,6 +73,7 @@ public sealed class FireExtinguisherSystem : EntitySystem
 
         args.Handled = true;
 
+        // TODO: why is this copy paste shit here just have fire extinguisher cancel transfer when safety is on
         var transfer = containerSolution.AvailableVolume;
         if (TryComp<SolutionTransferComponent>(entity.Owner, out var solTrans))
         {

Content.Server/Fluids/EntitySystems/PuddleSystem.Spillable.cs

@@ -1,5 +1,5 @@
 using Content.Server.Chemistry.Containers.EntitySystems;
-using Content.Server.Nutrition.EntitySystems;
+using Content.Server.Fluids.Components;
 using Content.Shared.Chemistry.Components;
 using Content.Shared.Chemistry.EntitySystems;
 using Content.Shared.Chemistry.Reaction;
@@ -11,6 +11,7 @@ using Content.Shared.FixedPoint;
 using Content.Shared.Fluids.Components;
 using Content.Shared.IdentityManagement;
 using Content.Shared.Inventory.Events;
+using Content.Shared.Nutrition.EntitySystems;
 using Content.Shared.Popups;
 using Content.Shared.Spillable;
 using Content.Shared.Throwing;

Content.Server/Glue/GlueSystem.cs

@@ -1,12 +1,12 @@
 using Content.Server.Administration.Logs;
 using Content.Server.Chemistry.Containers.EntitySystems;
-using Content.Server.Nutrition.EntitySystems;
 using Content.Shared.Database;
 using Content.Shared.Glue;
 using Content.Shared.Hands;
 using Content.Shared.Interaction;
 using Content.Shared.Interaction.Components;
 using Content.Shared.Item;
+using Content.Shared.Nutrition.EntitySystems;
 using Content.Shared.Popups;
 using Content.Shared.Verbs;
 using Robust.Shared.Audio.Systems;

Content.Server/Lube/LubeSystem.cs

@@ -1,12 +1,12 @@
 using Content.Server.Administration.Logs;
 using Content.Server.Chemistry.Containers.EntitySystems;
-using Content.Server.Nutrition.EntitySystems;
 using Content.Shared.Database;
 using Content.Shared.Glue;
 using Content.Shared.IdentityManagement;
 using Content.Shared.Interaction;
 using Content.Shared.Item;
 using Content.Shared.Lube;
+using Content.Shared.Nutrition.EntitySystems;
 using Content.Shared.Popups;
 using Content.Shared.Verbs;
 using Robust.Shared.Audio;

Content.Server/Materials/MaterialReclaimerSystem.cs

@@ -1,8 +1,6 @@
 using Content.Server.Chemistry.Containers.EntitySystems;
-using Content.Server.Chemistry.EntitySystems;
 using Content.Server.Fluids.EntitySystems;
 using Content.Server.GameTicking;
-using Content.Server.Nutrition.EntitySystems;
 using Content.Server.Popups;
 using Content.Server.Power.Components;
 using Content.Server.Stack;
@@ -10,11 +8,13 @@ using Content.Server.Wires;
 using Content.Shared.Body.Systems;
 using Content.Shared.Chemistry.Components;
 using Content.Shared.Chemistry.Components.SolutionManager;
+using Content.Shared.Chemistry.EntitySystems;
 using Content.Shared.IdentityManagement;
 using Content.Shared.Interaction;
 using Content.Shared.Interaction.Events;
 using Content.Shared.Materials;
 using Content.Shared.Mind;
+using Content.Shared.Nutrition.EntitySystems;
 using Robust.Server.GameObjects;
 using Robust.Shared.Player;
 using Robust.Shared.Utility;

Content.Server/NPC/Systems/NPCUtilitySystem.cs

@@ -14,6 +14,7 @@ using Content.Shared.Inventory;
 using Content.Shared.Mobs.Systems;
 using Content.Shared.NPC.Systems;
 using Content.Shared.Nutrition.Components;
+using Content.Shared.Nutrition.EntitySystems;
 using Content.Shared.Tools.Systems;
 using Content.Shared.Weapons.Melee;
 using Content.Shared.Weapons.Ranged.Components;

Content.Server/Nutrition/EntitySystems/DrinkSystem.cs

@@ -24,6 +24,7 @@ using Content.Shared.Interaction.Events;
 using Content.Shared.Mobs.Systems;
 using Content.Shared.Nutrition;
 using Content.Shared.Nutrition.Components;
+using Content.Shared.Nutrition.EntitySystems;
 using Content.Shared.Throwing;
 using Content.Shared.Verbs;
 using Robust.Shared.Audio;

Content.Server/Nutrition/EntitySystems/FoodSystem.cs

@@ -23,6 +23,7 @@ using Content.Shared.Interaction.Events;
 using Content.Shared.Inventory;
 using Content.Shared.Mobs.Systems;
 using Content.Shared.Nutrition;
+using Content.Shared.Nutrition.EntitySystems;
 using Content.Shared.Stacks;
 using Content.Shared.Storage;
 using Content.Shared.Verbs;

Content.Server/Nutrition/EntitySystems/OpenableSystem.cs

@@ -1,27 +0,0 @@
-using Content.Server.Chemistry.EntitySystems;
-using Content.Shared.Nutrition.EntitySystems;
-using Content.Shared.Nutrition.Components;
-
-namespace Content.Server.Nutrition.EntitySystems;
-
-/// <summary>
-/// Provides API for openable food and drinks, handles opening on use and preventing transfer when closed.
-/// </summary>
-public sealed class OpenableSystem : SharedOpenableSystem
-{
-    public override void Initialize()
-    {
-        base.Initialize();
-
-        SubscribeLocalEvent<OpenableComponent, SolutionTransferAttemptEvent>(OnTransferAttempt);
-    }
-
-    private void OnTransferAttempt(EntityUid uid, OpenableComponent comp, SolutionTransferAttemptEvent args)
-    {
-        if (!comp.Opened)
-        {
-            // message says its just for drinks, shouldn't matter since you typically dont have a food that is openable and can be poured out
-            args.Cancel(Loc.GetString("drink-component-try-use-drink-not-open", ("owner", uid)));
-        }
-    }
-}