Add extension methods to get a player's id and tests (#3630)

* Add extension methods to get a player's id and tests

* More extensive tests

* Make inventory check for ids first

* Rename to GetHeldId and TryGetHeldId

Content.IntegrationTests/Tests/PDA/PDAExtensionsTests.cs

@@ -0,0 +1,125 @@
+using System.Linq;
+using System.Threading.Tasks;
+using Content.Server.GameObjects.Components.Access;
+using Content.Server.GameObjects.Components.GUI;
+using Content.Server.GameObjects.Components.Items.Storage;
+using Content.Server.GameObjects.Components.PDA;
+using Content.Server.Interfaces.GameObjects.Components.Items;
+using NUnit.Framework;
+using Robust.Server.Player;
+using Robust.Shared.GameObjects;
+
+namespace Content.IntegrationTests.Tests.PDA
+{
+    public class PDAExtensionsTests : ContentIntegrationTest
+    {
+        private const string IdCardDummy = "DummyIdCard";
+        private const string PdaDummy = "DummyPda";
+
+        private static readonly string Prototypes = $@"
+- type: entity
+  id: {IdCardDummy}
+  name: {IdCardDummy}
+  components:
+  - type: IdCard
+  - type: Item
+
+- type: entity
+  id: {PdaDummy}
+  name: {PdaDummy}
+  components:
+  - type: PDA
+    idCard: {IdCardDummy}
+  - type: Item";
+
+        [Test]
+        public async Task PlayerGetIdComponent()
+        {
+            var clientOptions = new ClientIntegrationOptions
+            {
+                ExtraPrototypes = Prototypes
+            };
+
+            var serverOptions = new ServerIntegrationOptions
+            {
+                ExtraPrototypes = Prototypes
+            };
+
+            var (client, server) = await StartConnectedServerClientPair(clientOptions, serverOptions);
+
+            await Task.WhenAll(client.WaitIdleAsync(), server.WaitIdleAsync());
+
+            var sPlayerManager = server.ResolveDependency<IPlayerManager>();
+            var sEntityManager = server.ResolveDependency<IEntityManager>();
+
+            await server.WaitAssertion(() =>
+            {
+                var player = sPlayerManager.GetAllPlayers().Single().AttachedEntity;
+
+                Assert.NotNull(player);
+
+                // The player spawns with an ID on by default
+                Assert.NotNull(player.GetHeldId());
+                Assert.True(player.TryGetHeldId(out var id));
+                Assert.NotNull(id);
+
+                // Put PDA in hand
+                var dummyPda = sEntityManager.SpawnEntity(PdaDummy, player.Transform.MapPosition);
+                var pdaItemComponent = dummyPda.GetComponent<ItemComponent>();
+                player.GetComponent<IHandsComponent>().PutInHand(pdaItemComponent);
+
+                var pdaComponent = dummyPda.GetComponent<PDAComponent>();
+                var pdaIdCard = sEntityManager.SpawnEntity(IdCardDummy, player.Transform.MapPosition).GetComponent<IdCardComponent>();
+                pdaComponent.InsertIdCard(pdaIdCard);
+                var pdaContainedId = pdaComponent.ContainedID;
+
+                // The PDA in the hand should be found first
+                Assert.NotNull(player.GetHeldId());
+                Assert.True(player.TryGetHeldId(out id));
+                Assert.NotNull(id);
+                Assert.That(id, Is.EqualTo(pdaContainedId));
+
+                // Put ID card in hand
+                var idDummy = sEntityManager.SpawnEntity(IdCardDummy, player.Transform.MapPosition);
+                var idItemComponent = idDummy.GetComponent<ItemComponent>();
+                player.GetComponent<IHandsComponent>().PutInHand(idItemComponent);
+
+                var idCardComponent = idDummy.GetComponent<IdCardComponent>();
+
+                // The ID in the hand should be found first
+                Assert.NotNull(player.GetHeldId());
+                Assert.True(player.TryGetHeldId(out id));
+                Assert.NotNull(id);
+                Assert.That(id, Is.EqualTo(idCardComponent));
+
+                // Remove all IDs and PDAs
+                var inventory = player.GetComponent<InventoryComponent>();
+
+                foreach (var slot in inventory.Slots)
+                {
+                    var item = inventory.GetSlotItem(slot);
+
+                    if (item == null)
+                    {
+                        continue;
+                    }
+
+                    if (item.Owner.HasComponent<PDAComponent>())
+                    {
+                        inventory.ForceUnequip(slot);
+                    }
+                }
+
+                var hands = player.GetComponent<IHandsComponent>();
+
+                hands.Drop(dummyPda, false);
+                hands.Drop(idDummy, false);
+
+                // No ID
+                Assert.Null(player.GetHeldId());
+                Assert.False(player.TryGetHeldId(out id));
+                Assert.Null(id);
+            });
+        }
+    }
+}

Content.Server/GameObjects/Components/PDA/PDAExtensions.cs

@@ -0,0 +1,80 @@
+#nullable enable
+using System.Diagnostics.CodeAnalysis;
+using Content.Server.GameObjects.Components.Access;
+using Content.Server.GameObjects.Components.GUI;
+using Content.Server.Interfaces.GameObjects.Components.Items;
+using Robust.Shared.GameObjects;
+
+namespace Content.Server.GameObjects.Components.PDA
+{
+    public static class PdaExtensions
+    {
+        /// <summary>
+        ///     Gets the id that a player is holding in their hands or inventory.
+        ///     Order: Hands > ID slot > PDA in ID slot
+        /// </summary>
+        /// <param name="player">The player to check in.</param>
+        /// <returns>The id card component.</returns>
+        public static IdCardComponent? GetHeldId(this IEntity player)
+        {
+            IdCardComponent? firstIdInPda = null;
+
+            if (player.TryGetComponent(out IHandsComponent? hands))
+            {
+                foreach (var item in hands.GetAllHeldItems())
+                {
+                    if (firstIdInPda == null &&
+                        item.Owner.TryGetComponent(out PDAComponent? pda) &&
+                        pda.ContainedID != null)
+                    {
+                        firstIdInPda = pda.ContainedID;
+                    }
+
+                    if (item.Owner.TryGetComponent(out IdCardComponent? card))
+                    {
+                        return card;
+                    }
+                }
+            }
+
+            if (firstIdInPda != null)
+            {
+                return firstIdInPda;
+            }
+
+            IdCardComponent? firstIdInInventory = null;
+
+            if (player.TryGetComponent(out InventoryComponent? inventory))
+            {
+                foreach (var item in inventory.GetAllHeldItems())
+                {
+                    if (firstIdInInventory == null &&
+                        item.TryGetComponent(out PDAComponent? pda) &&
+                        pda.ContainedID != null)
+                    {
+                        firstIdInInventory = pda.ContainedID;
+                    }
+
+                    if (item.TryGetComponent(out IdCardComponent? card))
+                    {
+                        return card;
+                    }
+                }
+            }
+
+            return firstIdInInventory;
+        }
+
+        /// <summary>
+        ///     Gets the id that a player is holding in their hands or inventory.
+        ///     Order: Hands > ID slot > PDA in ID slot
+        /// </summary>
+        /// <param name="player">The player to check in.</param>
+        /// <param name="id">The id card component.</param>
+        /// <returns>true if found, false otherwise.</returns>
+        public static bool TryGetHeldId(this IEntity player, [NotNullWhen(true)] out IdCardComponent? id)
+        {
+            return (id = player.GetHeldId()) != null;
+        }
+    }
+}

SpaceStation14.sln.DotSettings

@@ -130,6 +130,7 @@
 	<s:Boolean x:Key="/Default/UserDictionary/Words/=Octile/@EntryIndexedValue">True</s:Boolean>
 	<s:Boolean x:Key="/Default/UserDictionary/Words/=Pathfind/@EntryIndexedValue">True</s:Boolean>
 	<s:Boolean x:Key="/Default/UserDictionary/Words/=Patreon/@EntryIndexedValue">True</s:Boolean>
+	<s:Boolean x:Key="/Default/UserDictionary/Words/=pdas/@EntryIndexedValue">True</s:Boolean>
 	<s:Boolean x:Key="/Default/UserDictionary/Words/=Phoron/@EntryIndexedValue">True</s:Boolean>
 	<s:Boolean x:Key="/Default/UserDictionary/Words/=pipenet/@EntryIndexedValue">True</s:Boolean>
 	<s:Boolean x:Key="/Default/UserDictionary/Words/=placeable/@EntryIndexedValue">True</s:Boolean>