Paper Bins (#13449)

Content.Shared/Storage/EntitySystems/BinSystem.cs

@@ -0,0 +1,159 @@
+using System.Diagnostics.CodeAnalysis;
+using System.Linq;
+using Content.Shared.Administration.Logs;
+using Content.Shared.Database;
+using Content.Shared.Hands.EntitySystems;
+using Content.Shared.Interaction;
+using Content.Shared.Storage.Components;
+using Robust.Shared.Containers;
+using Robust.Shared.GameStates;
+using Robust.Shared.Network;
+using Robust.Shared.Timing;
+
+namespace Content.Shared.Storage.EntitySystems;
+
+/// <summary>
+/// This handles <see cref="BinComponent"/>
+/// </summary>
+public sealed class BinSystem : EntitySystem
+{
+    [Dependency] private readonly IGameTiming _timing = default!;
+    [Dependency] private readonly INetManager _net = default!;
+    [Dependency] private readonly ISharedAdminLogManager _admin = default!;
+    [Dependency] private readonly SharedContainerSystem _container = default!;
+    [Dependency] private readonly SharedHandsSystem _hands = default!;
+
+    public const string BinContainerId = "bin-container";
+
+    /// <inheritdoc/>
+    public override void Initialize()
+    {
+        SubscribeLocalEvent<BinComponent, ComponentGetState>(OnGetState);
+        SubscribeLocalEvent<BinComponent, ComponentHandleState>(OnHandleState);
+        SubscribeLocalEvent<BinComponent, ComponentStartup>(OnStartup);
+        SubscribeLocalEvent<BinComponent, MapInitEvent>(OnMapInit);
+        SubscribeLocalEvent<BinComponent, EntRemovedFromContainerMessage>(OnEntRemoved);
+        SubscribeLocalEvent<BinComponent, InteractHandEvent>(OnInteractHand);
+        SubscribeLocalEvent<BinComponent, AfterInteractUsingEvent>(OnAfterInteractUsing);
+    }
+
+    private void OnGetState(EntityUid uid, BinComponent component, ref ComponentGetState args)
+    {
+        args.State = new BinComponentState(component.Items, component.Whitelist, component.MaxItems);
+    }
+
+    private void OnHandleState(EntityUid uid, BinComponent component, ref ComponentHandleState args)
+    {
+        if (args.Current is not BinComponentState state)
+            return;
+
+        component.Items = new List<EntityUid>(state.Items);
+        component.Whitelist = state.Whitelist;
+        component.MaxItems = state.MaxItems;
+    }
+
+    private void OnStartup(EntityUid uid, BinComponent component, ComponentStartup args)
+    {
+        component.ItemContainer = _container.EnsureContainer<Container>(uid, BinContainerId);
+    }
+
+    private void OnMapInit(EntityUid uid, BinComponent component, MapInitEvent args)
+    {
+        // don't spawn on the client.
+        if (_net.IsClient)
+            return;
+
+        var xform = Transform(uid);
+        foreach (var id in component.InitialContents)
+        {
+            var ent = Spawn(id, xform.Coordinates);
+            if (!TryInsertIntoBin(uid, ent, component))
+            {
+                Logger.Error($"Entity {ToPrettyString(ent)} was unable to be initialized into bin {ToPrettyString(uid)}");
+                return;
+            }
+        }
+    }
+
+    private void OnEntRemoved(EntityUid uid, BinComponent component, EntRemovedFromContainerMessage args)
+    {
+        component.Items.Remove(args.Entity);
+    }
+
+    private void OnInteractHand(EntityUid uid, BinComponent component, InteractHandEvent args)
+    {
+        if (args.Handled || !_timing.IsFirstTimePredicted)
+            return;
+
+        EntityUid? toGrab = component.Items.LastOrDefault();
+        if (!TryRemoveFromBin(uid, toGrab, component))
+            return;
+
+        _hands.TryPickupAnyHand(args.User, toGrab.Value);
+        _admin.Add(LogType.Pickup, LogImpact.Low,
+            $"{ToPrettyString(uid):player} removed {ToPrettyString(toGrab.Value)} from bin {ToPrettyString(uid)}.");
+        args.Handled = true;
+    }
+
+    private void OnAfterInteractUsing(EntityUid uid, BinComponent component, AfterInteractUsingEvent args)
+    {
+        if (args.Handled || !args.CanReach)
+            return;
+
+        if (!_timing.IsFirstTimePredicted)
+            return;
+
+        if (!TryInsertIntoBin(uid, args.Used, component))
+            return;
+
+        _admin.Add(LogType.Pickup, LogImpact.Low, $"{ToPrettyString(uid):player} inserted {ToPrettyString(args.User)} into bin {ToPrettyString(uid)}.");
+        args.Handled = true;
+    }
+
+    /// <summary>
+    /// Inserts an entity at the top of the bin
+    /// </summary>
+    /// <param name="uid"></param>
+    /// <param name="toInsert"></param>
+    /// <param name="component"></param>
+    /// <returns></returns>
+    public bool TryInsertIntoBin(EntityUid uid, EntityUid toInsert, BinComponent? component = null)
+    {
+        if (!Resolve(uid, ref component))
+            return false;
+
+        if (component.Items.Count >= component.MaxItems)
+            return false;
+
+        if (component.Whitelist != null && !component.Whitelist.IsValid(toInsert))
+            return false;
+
+        component.ItemContainer.Insert(toInsert);
+        component.Items.Add(toInsert);
+        Dirty(component);
+        return true;
+    }
+
+    /// <summary>
+    /// Tries to remove an entity from the top of the bin.
+    /// </summary>
+    /// <param name="uid"></param>
+    /// <param name="toRemove"></param>
+    /// <param name="component"></param>
+    /// <returns></returns>
+    public bool TryRemoveFromBin(EntityUid uid, [NotNullWhen(true)] EntityUid? toRemove, BinComponent? component = null)
+    {
+        if (!Resolve(uid, ref component))
+            return false;
+        
+        if (toRemove != component.Items.Last())
+            return false;
+
+        if (!component.ItemContainer.Remove(toRemove.Value))
+            return false;
+
+        component.Items.Remove(toRemove.Value);
+        Dirty(component);
+        return true;
+    }
+}