Adds hand labelers (#4903)

* Adds hand labelers

* Removes unnecessary thing

* Docs

* Reverts some changes

* Addresses comments and adds inhand sprites

* Addressed comments

Co-authored-by: Watermelon914 <3052169-Watermelon914@users.noreply.gitlab.com>

Content.Server/HandLabeler/Components/HandLabelerComponent.cs

@@ -0,0 +1,26 @@
+using System;
+using Content.Server.Items;
+using Content.Shared.Whitelist;
+using Robust.Shared.GameObjects;
+using Robust.Shared.Serialization.Manager.Attributes;
+using Robust.Shared.ViewVariables;
+
+namespace Content.Server.HandLabeler.Components
+{
+    [RegisterComponent]
+    public class HandLabelerComponent : Component
+    {
+        public override string Name => "HandLabeler";
+
+        [ViewVariables(VVAccess.ReadWrite)]
+        [DataField("assignedLabel")]
+        public string AssignedLabel { get; set; } = string.Empty;
+
+        [ViewVariables(VVAccess.ReadWrite)]
+        [DataField("maxLabelChars")]
+        public int MaxLabelChars { get; set; } = 50;
+
+        [DataField("whitelist")]
+        public EntityWhitelist Whitelist = new();
+    }
+}

Content.Server/HandLabeler/Components/LabelComponent.cs

@@ -0,0 +1,18 @@
+using Robust.Shared.GameObjects;
+using Robust.Shared.Serialization.Manager.Attributes;
+using Robust.Shared.ViewVariables;
+
+namespace Content.Server.HandLabeler.Components
+{
+    [RegisterComponent]
+    public class LabelComponent : Component
+    {
+        public override string Name => "Label";
+
+        [ViewVariables(VVAccess.ReadWrite)]
+        [DataField("currentLabel")]
+        public string? CurrentLabel { get; set; }
+
+        public string? OriginalName { get; set; }
+    }
+}

Content.Server/HandLabeler/HandLabelerSystem.cs

@@ -0,0 +1,110 @@
+using Content.Server.HandLabeler.Components;
+using Content.Server.UserInterface;
+using Content.Shared.ActionBlocker;
+using Content.Shared.HandLabeler;
+using Content.Shared.Interaction;
+using Robust.Server.GameObjects;
+using Robust.Shared.GameObjects;
+using Robust.Shared.Players;
+using Robust.Shared.IoC;
+using JetBrains.Annotations;
+using Robust.Shared.Localization;
+using Content.Shared.Popups;
+using System;
+
+namespace Content.Server.HandLabeler
+{
+    /// <summary>
+    /// A hand labeler system that lets an object apply labels to objects with the <see cref="LabelComponent"/> .
+    /// </summary>
+    [UsedImplicitly]
+    public class HandLabelerSystem : EntitySystem
+    {
+        [Dependency] private readonly UserInterfaceSystem _userInterfaceSystem = default!;
+
+        public override void Initialize()
+        {
+            base.Initialize();
+
+            SubscribeLocalEvent<HandLabelerComponent, AfterInteractEvent>(AfterInteractOn);
+            SubscribeLocalEvent<HandLabelerComponent, UseInHandEvent>(OnUseInHand);
+            // Bound UI subscriptions
+            SubscribeLocalEvent<HandLabelerComponent, HandLabelerLabelChangedMessage>(OnHandLabelerLabelChanged);
+        }
+
+        private void AfterInteractOn(EntityUid uid, HandLabelerComponent handLabeler, AfterInteractEvent args)
+        {
+            if (args.Target == null || !handLabeler.Whitelist.IsValid(args.Target))
+                return;
+
+            AddLabelTo(uid, handLabeler, args.Target, out string? result);
+            if (result != null)
+                handLabeler.Owner.PopupMessage(args.User, result);
+        }
+
+        private void AddLabelTo(EntityUid uid, HandLabelerComponent? handLabeler, IEntity target, out string? result)
+        {
+            if (!Resolve(uid, ref handLabeler))
+            {
+                result = null;
+                return;
+            }
+
+            LabelComponent label = target.EnsureComponent<LabelComponent>();
+
+            if (label.OriginalName != null)
+                target.Name = label.OriginalName;
+            label.OriginalName = null;
+
+            if (handLabeler.AssignedLabel == string.Empty)
+            {
+                label.CurrentLabel = null;
+                result = Loc.GetString("hand-labeler-successfully-removed");
+                return;
+            }
+
+            label.OriginalName = target.Name;
+            target.Name += $" ({handLabeler.AssignedLabel})";
+            label.CurrentLabel = handLabeler.AssignedLabel;
+            result = Loc.GetString("hand-labeler-successfully-applied");
+        }
+
+        private void OnUseInHand(EntityUid uid, HandLabelerComponent handLabeler, UseInHandEvent args)
+        {
+            if (!args.User.TryGetComponent(out ActorComponent? actor))
+                return;
+
+            handLabeler.Owner.GetUIOrNull(HandLabelerUiKey.Key)?.Open(actor.PlayerSession);
+            args.Handled = true;
+        }
+
+        private bool CheckInteract(ICommonSession session)
+        {
+            if (session.AttachedEntity is not { } entity
+                || !Get<ActionBlockerSystem>().CanInteract(entity)
+                || !Get<ActionBlockerSystem>().CanUse(entity))
+                return false;
+
+            return true;
+        }
+
+        private void OnHandLabelerLabelChanged(EntityUid uid, HandLabelerComponent handLabeler, HandLabelerLabelChangedMessage args)
+        {
+            if (!CheckInteract(args.Session))
+                return;
+
+            handLabeler.AssignedLabel = args.Label.Trim().Substring(0, Math.Min(handLabeler.MaxLabelChars, args.Label.Length));
+            DirtyUI(uid, handLabeler);
+        }
+
+        private void DirtyUI(EntityUid uid,
+            HandLabelerComponent? handLabeler = null)
+        {
+            if (!Resolve(uid, ref handLabeler))
+                return;
+
+            _userInterfaceSystem.TrySetUiState(uid, HandLabelerUiKey.Key,
+                new HandLabelerBoundUserInterfaceState(handLabeler.AssignedLabel));
+        }
+    }
+}

Content.Server/HandLabeler/LabelSystem.cs

@@ -0,0 +1,36 @@
+using Content.Server.HandLabeler.Components;
+using Content.Shared.Examine;
+using JetBrains.Annotations;
+using Robust.Shared.GameObjects;
+using Robust.Shared.Localization;
+using Robust.Shared.Utility;
+
+namespace Content.Server.HandLabeler
+{
+    /// <summary>
+    /// A system that lets players see the contents of a label on an object.
+    /// </summary>
+    [UsedImplicitly]
+    public class LabelSystem : EntitySystem
+    {
+        public override void Initialize()
+        {
+            base.Initialize();
+
+            SubscribeLocalEvent<LabelComponent, ExaminedEvent>(OnExamine);
+        }
+
+        private void OnExamine(EntityUid uid, LabelComponent? label, ExaminedEvent args)
+        {
+            if (!Resolve(uid, ref label))
+                return;
+
+            if (label.CurrentLabel == null)
+                return;
+
+            var message = new FormattedMessage();
+            message.AddText(Loc.GetString("hand-labeler-has-label", ("label", label.CurrentLabel)));
+            args.PushMessage(message);
+        }
+    }
+}