fix: Customitems refactor

EXILED/Exiled.API/Features/Player.cs

@@ -75,6 +75,11 @@ namespace Exiled.API.Features
     public class Player : TypeCastObject<Player>, IEntity, IWorldSpace
     {
 #pragma warning disable SA1401
+        /// <summary>
+        /// A list of the player's CustomRole Ids.
+        /// </summary>
+        public readonly List<uint> CustomRoleIds = new();
+
         /// <summary>
         /// A list of the player's items.
         /// </summary>

EXILED/Exiled.CustomItems/API/Features/CustomArmor.cs

@@ -87,7 +87,7 @@ public override void Give(Player player, bool displayMessage = true)
 
             player.AddItem(armor);
 
-            TrackedSerials.Add(armor.Serial);
+            SerialLookupTable.Add(armor.Serial);
 
             Timing.CallDelayed(0.05f, () => OnAcquired(player, armor, displayMessage));
 
@@ -121,7 +121,7 @@ private void OnInternalPickingUpItem(PickingUpItemEventArgs ev)
 
             ev.IsAllowed = false;
 
-            TrackedSerials.Remove(ev.Pickup.Serial);
+            SerialLookupTable.Remove(ev.Pickup.Serial);
             ev.Pickup.Destroy();
 
             Give(ev.Player);

EXILED/Exiled.CustomItems/API/Features/CustomGrenade.cs

@@ -105,7 +105,7 @@ public virtual Pickup Throw(Vector3 position, float force, float weight, float f
         /// </summary>
         /// <param name="grenade">The <see cref="Projectile">grenade</see> to check.</param>
         /// <returns>True if it is a custom grenade.</returns>
-        public virtual bool Check(Projectile grenade) => grenade is not null && TrackedSerials.Contains(grenade.Serial);
+        public virtual bool Check(Projectile grenade) => grenade is not null && SerialLookupTable.Contains(grenade.Serial);
 
         /// <inheritdoc/>
         protected override void SubscribeEvents()

EXILED/Exiled.CustomItems/API/Features/CustomItem.cs

@@ -34,10 +34,8 @@ namespace Exiled.CustomItems.API.Features
 
     using static CustomItems;
 
-    using BaseFirearmPickup = InventorySystem.Items.Firearms.FirearmPickup;
     using Firearm = Exiled.API.Features.Items.Firearm;
     using Item = Exiled.API.Features.Items.Item;
-    using Map = Exiled.API.Features.Map;
     using Player = Exiled.API.Features.Player;
     using UpgradingPickupEventArgs = Exiled.Events.EventArgs.Scp914.UpgradingPickupEventArgs;
 
@@ -46,8 +44,9 @@ namespace Exiled.CustomItems.API.Features
     /// </summary>
     public abstract class CustomItem
     {
-        private static Dictionary<string, CustomItem?> stringLookupTable = new();
-        private static Dictionary<uint, CustomItem?> idLookupTable = new();
+        private static readonly Dictionary<string, CustomItem?> StringLookupTable = new();
+        private static readonly Dictionary<uint, CustomItem?> IdLookupTable = new();
+        private static readonly Dictionary<ushort, CustomItem?> SerialLookupTable = new();
 
         private ItemType type = ItemType.None;
 
@@ -101,12 +100,6 @@ public virtual ItemType Type
             }
         }
 
-        /// <summary>
-        /// Gets the list of custom items inside players' inventory being tracked as the current item.
-        /// </summary>
-        [YamlIgnore]
-        public HashSet<int> TrackedSerials { get; } = new();
-
         /// <summary>
         /// Gets a value indicating whether this item causes things to happen that may be considered hacks, and thus be shown to global moderators as being present in a player's inventory when they gban them.
         /// </summary>
@@ -120,9 +113,9 @@ public virtual ItemType Type
         /// <returns>The <see cref="CustomItem"/> matching the search, <see langword="null"/> if not registered.</returns>
         public static CustomItem? Get(uint id)
         {
-            if (!idLookupTable.ContainsKey(id))
-                idLookupTable.Add(id, Registered.FirstOrDefault(i => i.Id == id));
-            return idLookupTable[id];
+            if (!IdLookupTable.ContainsKey(id))
+                IdLookupTable.Add(id, Registered.FirstOrDefault(i => i.Id == id));
+            return IdLookupTable[id];
         }
 
         /// <summary>
@@ -132,9 +125,9 @@ public virtual ItemType Type
         /// <returns>The <see cref="CustomItem"/> matching the search, <see langword="null"/> if not registered.</returns>
         public static CustomItem? Get(string name)
         {
-            if (!stringLookupTable.ContainsKey(name))
-                stringLookupTable.Add(name, Registered.FirstOrDefault(i => i.Name == name));
-            return stringLookupTable[name];
+            if (!StringLookupTable.ContainsKey(name))
+                StringLookupTable.Add(name, Registered.FirstOrDefault(i => i.Name == name));
+            return StringLookupTable[name];
         }
 
         /// <summary>
@@ -221,47 +214,57 @@ public static bool TryGet(Player player, out IEnumerable<CustomItem>? customItem
             return customItems.Any();
         }
 
+        /// <summary>
+        /// Checks if this serial is a custom item.
+        /// </summary>
+        /// <param name="serial">The serial to check.</param>
+        /// <param name="customItem">The <see cref="CustomItem"/> this item is.</param>
+        /// <returns>True if the serial is a custom item.</returns>
+        public static bool TryGet(ushort serial, out CustomItem? customItem) => SerialLookupTable.TryGetValue(serial, out customItem);
+
         /// <summary>
         /// Checks to see if this item is a custom item.
         /// </summary>
         /// <param name="item">The <see cref="Item"/> to check.</param>
         /// <param name="customItem">The <see cref="CustomItem"/> this item is.</param>
         /// <returns>True if the item is a custom item.</returns>
-        public static bool TryGet(Item item, out CustomItem? customItem)
-        {
-            customItem = item == null ? null : Registered?.FirstOrDefault(tempCustomItem => tempCustomItem.TrackedSerials.Contains(item.Serial));
-
-            return customItem is not null;
-        }
+        /// <exception cref="ArgumentNullException">Thrown if <paramref name="item"/> is <see langword="null"/>.</exception>
+        public static bool TryGet(Item item, out CustomItem? customItem) => TryGet(item.Serial, out customItem);
 
         /// <summary>
         /// Checks if this pickup is a custom item.
         /// </summary>
         /// <param name="pickup">The <see cref="ItemPickupBase"/> to check.</param>
         /// <param name="customItem">The <see cref="CustomItem"/> this pickup is.</param>
         /// <returns>True if the pickup is a custom item.</returns>
-        public static bool TryGet(Pickup pickup, out CustomItem? customItem)
-        {
-            customItem = Registered?.FirstOrDefault(tempCustomItem => tempCustomItem.TrackedSerials.Contains(pickup.Serial));
+        /// <exception cref="ArgumentNullException">Thrown if <paramref name="pickup"/> is <see langword="null"/>.</exception>
+        public static bool TryGet(Pickup pickup, out CustomItem? customItem) => TryGet(pickup.Serial, out customItem);
 
-            return customItem is not null;
-        }
+        /// <summary>
+        /// Tries to spawn a specific <see cref="CustomItem"/> at a specific <see cref="Vector3"/> position.
+        /// </summary>
+        /// <param name="id">The ID of the <see cref="CustomItem"/> to spawn.</param>
+        /// <param name="position">The <see cref="Vector3"/> location to spawn the item.</param>
+        /// <param name="pickup">The <see cref="ItemPickupBase"/> instance of the <see cref="CustomItem"/>.</param>
+        /// <returns>Returns a value indicating whether the <see cref="CustomItem"/> was spawned.</returns>
+        public static bool TrySpawn(uint id, Vector3 position, out Pickup? pickup) => TrySpawn(id, position, out pickup, out _);
 
         /// <summary>
         /// Tries to spawn a specific <see cref="CustomItem"/> at a specific <see cref="Vector3"/> position.
         /// </summary>
         /// <param name="id">The ID of the <see cref="CustomItem"/> to spawn.</param>
         /// <param name="position">The <see cref="Vector3"/> location to spawn the item.</param>
         /// <param name="pickup">The <see cref="ItemPickupBase"/> instance of the <see cref="CustomItem"/>.</param>
+        /// <param name="customItem">The <see cref="CustomItem"/>.</param>
         /// <returns>Returns a value indicating whether the <see cref="CustomItem"/> was spawned.</returns>
-        public static bool TrySpawn(uint id, Vector3 position, out Pickup? pickup)
+        public static bool TrySpawn(uint id, Vector3 position, out Pickup? pickup, out CustomItem? customItem)
         {
             pickup = default;
 
-            if (!TryGet(id, out CustomItem? item))
+            if (!TryGet(id, out customItem))
                 return false;
 
-            pickup = item?.Spawn(position);
+            pickup = customItem?.Spawn(position);
 
             return true;
         }
@@ -552,7 +555,7 @@ public static IEnumerable<CustomItem> UnregisterItems(IEnumerable<Type> targetTy
             if (previousOwner is not null)
                 pickup.PreviousOwner = previousOwner;
 
-            TrackedSerials.Add(pickup.Serial);
+            SerialLookupTable[pickup.Serial] = this;
 
             return pickup;
         }
@@ -648,8 +651,7 @@ public virtual void Give(Player player, Item item, bool displayMessage = true)
                 player.AddItem(item);
 
                 Log.Debug($"{nameof(Give)}: Adding {item.Serial} to tracker.");
-                if (!TrackedSerials.Contains(item.Serial))
-                    TrackedSerials.Add(item.Serial);
+                SerialLookupTable[item.Serial] = this;
 
                 Timing.CallDelayed(0.05f, () => OnAcquired(player, item, displayMessage));
             }
@@ -679,8 +681,8 @@ public virtual void Give(Player player, Item item, bool displayMessage = true)
         /// </summary>
         public virtual void Init()
         {
-            stringLookupTable.Add(Name, this);
-            idLookupTable.Add(Id, this);
+            StringLookupTable.Add(Name, this);
+            IdLookupTable.Add(Id, this);
 
             SubscribeEvents();
         }
@@ -692,23 +694,23 @@ public virtual void Destroy()
         {
             UnsubscribeEvents();
 
-            stringLookupTable.Remove(Name);
-            idLookupTable.Remove(Id);
+            StringLookupTable.Remove(Name);
+            IdLookupTable.Remove(Id);
         }
 
         /// <summary>
         /// Checks the specified pickup to see if it is a custom item.
         /// </summary>
         /// <param name="pickup">The <see cref="Pickup"/> to check.</param>
         /// <returns>True if it is a custom item.</returns>
-        public virtual bool Check(Pickup? pickup) => pickup is not null && TrackedSerials.Contains(pickup.Serial);
+        public virtual bool Check(Pickup? pickup) => pickup is not null && Check(pickup.Serial);
 
         /// <summary>
         /// Checks the specified inventory item to see if it is a custom item.
         /// </summary>
         /// <param name="item">The <see cref="Item"/> to check.</param>
         /// <returns>True if it is a custom item.</returns>
-        public virtual bool Check(Item? item) => item is not null && TrackedSerials.Contains(item.Serial);
+        public virtual bool Check(Item? item) => item is not null && Check(item.Serial);
 
         /// <summary>
         /// Checks the specified player's current item to see if it is a custom item.
@@ -717,6 +719,13 @@ public virtual void Destroy()
         /// <returns>True if it is a custom item.</returns>
         public virtual bool Check(Player? player) => Check(player?.CurrentItem);
 
+        /// <summary>
+        /// Checks the specified player's current item to see if it is a custom item.
+        /// </summary>
+        /// <param name="serial">The serial of the <see cref="Item"/>/<see cref="Pickup"/> to check.</param>
+        /// <returns>True if it is a custom item.</returns>
+        public virtual bool Check(ushort serial) => SerialLookupTable.TryGetValue(serial, out CustomItem? customItem) && customItem!.Id == Id;
+
         /// <inheritdoc/>
         public override string ToString() => $"[{Name} ({Type}) | {Id}] {Description}";
 
@@ -912,7 +921,7 @@ protected virtual void OnAcquired(Player player, Item item, bool displayMessage)
         /// </summary>
         protected virtual void OnWaitingForPlayers()
         {
-            TrackedSerials.Clear();
+            SerialLookupTable.Clear();
         }
 
         /// <summary>
@@ -937,91 +946,37 @@ protected virtual void ShowSelectedMessage(Player player)
 
         private void OnInternalOwnerChangingRole(ChangingRoleEventArgs ev)
         {
-            if (ev.Reason is SpawnReason.Escaped or SpawnReason.Destroyed)
-                return;
-
-            foreach (Item item in ev.Player.Items.ToList())
+            foreach (Item item in ev.Player.Items)
             {
-                if (!Check(item))
-                    continue;
-
-                OnOwnerChangingRole(new OwnerChangingRoleEventArgs(item.Base, ev));
-
-                TrackedSerials.Remove(item.Serial);
-
-                ev.Player.RemoveItem(item);
-
-                Spawn(ev.Player, item, ev.Player);
+                if (Check(item))
+                    OnOwnerChangingRole(new OwnerChangingRoleEventArgs(item.Base, ev));
             }
-
-            MirrorExtensions.ResyncSyncVar(ev.Player.ReferenceHub.networkIdentity, typeof(NicknameSync), nameof(NicknameSync.Network_myNickSync));
         }
 
         private void OnInternalOwnerDying(DyingEventArgs ev)
         {
-            foreach (Item item in ev.Player.Items.ToList())
+            foreach (Item item in ev.Player.Items)
             {
-                if (!Check(item))
-                    continue;
-
-                OnOwnerDying(new OwnerDyingEventArgs(item, ev));
-
-                if (!ev.IsAllowed)
-                    continue;
-
-                ev.Player.RemoveItem(item);
-
-                TrackedSerials.Remove(item.Serial);
-
-                Spawn(ev.Player, item, ev.Player);
-
-                MirrorExtensions.ResyncSyncVar(ev.Player.ReferenceHub.networkIdentity, typeof(NicknameSync), nameof(NicknameSync.Network_myNickSync));
+                if (Check(item))
+                    OnOwnerDying(new OwnerDyingEventArgs(item, ev));
             }
-
-            MirrorExtensions.ResyncSyncVar(ev.Player.ReferenceHub.networkIdentity, typeof(NicknameSync), nameof(NicknameSync.Network_myNickSync));
         }
 
         private void OnInternalOwnerEscaping(EscapingEventArgs ev)
         {
-            foreach (Item item in ev.Player.Items.ToList())
+            foreach (Item item in ev.Player.Items)
             {
-                if (!Check(item))
-                    continue;
-
-                OnOwnerEscaping(new OwnerEscapingEventArgs(item, ev));
-
-                if (!ev.IsAllowed)
-                    continue;
-
-                ev.Player.RemoveItem(item);
-
-                TrackedSerials.Remove(item.Serial);
-
-                Timing.CallDelayed(1.5f, () => Spawn(ev.Player.Position, item, null));
-
-                MirrorExtensions.ResyncSyncVar(ev.Player.ReferenceHub.networkIdentity, typeof(NicknameSync), nameof(NicknameSync.Network_myNickSync));
+                if (Check(item))
+                    OnOwnerEscaping(new OwnerEscapingEventArgs(item, ev));
             }
-
-            MirrorExtensions.ResyncSyncVar(ev.Player.ReferenceHub.networkIdentity, typeof(NicknameSync), nameof(NicknameSync.Network_myNickSync));
         }
 
         private void OnInternalOwnerHandcuffing(HandcuffingEventArgs ev)
         {
-            foreach (Item item in ev.Target.Items.ToList())
+            foreach (Item item in ev.Target.Items)
             {
-                if (!Check(item))
-                    continue;
-
-                OnOwnerHandcuffing(new OwnerHandcuffingEventArgs(item, ev));
-
-                if (!ev.IsAllowed)
-                    continue;
-
-                ev.Target.RemoveItem(item);
-
-                TrackedSerials.Remove(item.Serial);
-
-                Spawn(ev.Target, item, ev.Target);
+                if (Check(item))
+                    OnOwnerHandcuffing(new OwnerHandcuffingEventArgs(item, ev));
             }
         }
 

EXILED/Exiled.CustomItems/API/Features/CustomWeapon.cs

@@ -94,7 +94,7 @@
             if (previousOwner is not null)
                 pickup.PreviousOwner = previousOwner;
 
-            TrackedSerials.Add(pickup.Serial);
+            SerialLookupTable.Add(pickup.Serial);
             return pickup;
         }
 
@@ -116,7 +116,7 @@
                 if (previousOwner is not null)
                     pickup.PreviousOwner = previousOwner;
 
-                TrackedSerials.Add(pickup.Serial);
+                SerialLookupTable.Add(pickup.Serial);
                 return pickup;
             }
 
@@ -138,7 +138,7 @@
             }
 
             Log.Debug($"{nameof(Give)}: Adding {item.Serial} to tracker.");
-            TrackedSerials.Add(item.Serial);
+            SerialLookupTable.Add(item.Serial);
 
             OnAcquired(player, item, displayMessage);
         }

EXILED/Exiled.CustomItems/Commands/List/Tracked.cs

@@ -62,16 +62,16 @@
 
             foreach (CustomItem customItem in CustomItem.Registered)
             {
                 if (customItem.TrackedSerials.Count == 0)
                     continue;
 
                 message.AppendLine()
                     .Append('[').Append(customItem.Id).Append(". ").Append(customItem.Name).Append(" (").Append(customItem.Type).Append(')')
                     .Append(" {").Append(customItem.TrackedSerials.Count).AppendLine("}]").AppendLine();
 
                 count += customItem.TrackedSerials.Count;
 
-                foreach (int insideInventory in customItem.TrackedSerials)
+                foreach (int insideInventory in customItem.SerialLookupTable)
                 {
                     Player owner = Player.List.FirstOrDefault(player => player.Inventory.UserInventory.Items.Any(item => item.Key == insideInventory));