Refactored CustomItems to use CustomObject as a base method which provides registration and lookup

Author: marchellcx

LabExtended/API/Custom/CustomObject.cs

@@ -0,0 +1,163 @@
+using YamlDotNet.Serialization;
+
+namespace LabExtended.API.Custom
+{
+    /// <summary>
+    /// Base class for custom objects.
+    /// </summary>
+    public abstract class CustomObject<T> where T : class
+    {
+        private static Dictionary<string, T> registered = new();
+
+        /// <summary>
+        /// Gets a read-only dictionary of all registered custom objects.
+        /// </summary>
+        public static IReadOnlyDictionary<string, T> RegisteredObjects => registered;
+
+        /// <summary>
+        /// Retrieves the registered object associated with the specified identifier.
+        /// </summary>
+        /// <param name="id">The unique identifier of the registered object to retrieve. Cannot be null or empty.</param>
+        /// <returns>The object of type T that is registered with the specified identifier.</returns>
+        /// <exception cref="ArgumentNullException">Thrown if <paramref name="id"/> is null or empty.</exception>
+        /// <exception cref="KeyNotFoundException">Thrown if no object is registered with the specified <paramref name="id"/>.</exception>
+        public static T Get(string id)
+        {
+            if (string.IsNullOrEmpty(id))
+                throw new ArgumentNullException(nameof(id));
+
+            if (!registered.TryGetValue(id, out var customObject))
+                throw new KeyNotFoundException($"No custom object with ID '{id}' is registered.");
+
+            return customObject;
+        }
+
+        /// <summary>
+        /// Retrieves the first registered object that matches the specified predicate.
+        /// </summary>
+        /// <param name="predicate">A delegate that defines the conditions of the object to search for. The predicate is applied to each
+        /// registered object until a match is found.</param>
+        /// <returns>The first registered object that satisfies the specified predicate.</returns>
+        /// <exception cref="ArgumentNullException">Thrown if <paramref name="predicate"/> is <see langword="null"/>.</exception>
+        /// <exception cref="KeyNotFoundException">Thrown if no registered object matches the specified predicate.</exception>
+        public static T Get(Predicate<T> predicate)
+        {
+            if (predicate is null)
+                throw new ArgumentNullException(nameof(predicate));
+
+            foreach (var obj in registered.Values)
+            {
+                if (predicate(obj))
+                {
+                    return obj;
+                }
+            }
+
+            throw new KeyNotFoundException("No custom object matching the given predicate is registered.");
+        }
+
+        /// <summary>
+        /// Attempts to retrieve a registered object of type T associated with the specified identifier.
+        /// </summary>
+        /// <param name="id">The unique identifier of the object to retrieve. Cannot be null or empty.</param>
+        /// <param name="customObject">When this method returns, contains the object associated with the specified identifier, if found; otherwise,
+        /// the default value for type T.</param>
+        /// <returns>true if an object with the specified identifier is found; otherwise, false.</returns>
+        public static bool TryGet(string id, out T customObject)
+        {
+            customObject = null!;
+
+            if (string.IsNullOrEmpty(id))
+                return false;
+
+            return registered.TryGetValue(id, out customObject);
+        }
+
+        /// <summary>
+        /// Attempts to retrieve the first registered object that matches the specified predicate.
+        /// </summary>
+        /// <param name="predicate">A delegate that defines the conditions of the object to search for. Cannot be null.</param>
+        /// <param name="customObject">When this method returns, contains the first object that matches the predicate, if found; otherwise, the
+        /// default value for type T.</param>
+        /// <returns>true if an object matching the predicate is found; otherwise, false.</returns>
+        /// <exception cref="ArgumentNullException">Thrown if predicate is null.</exception>
+        public static bool TryGet(Predicate<T> predicate, out T customObject)
+        {
+            if (predicate is null)
+                throw new ArgumentNullException(nameof(predicate));
+
+            customObject = null!;
+
+            foreach (var obj in registered.Values)
+            {
+                if (predicate(obj))
+                {
+                    customObject = obj;
+                    return true;
+                }
+            }
+
+            return false;
+        }
+
+        /// <summary>
+        /// Gets the ID of the custom object.
+        /// </summary>
+        [YamlIgnore]
+        public abstract string Id { get; }
+
+        /// <summary>
+        /// Whether or not the object is registered.
+        /// </summary>
+        [YamlIgnore]
+        public bool IsRegistered { get; private set; }
+
+        /// <summary>
+        /// Registers this custom object.
+        /// </summary>
+        /// <returns>true if the object got registered</returns>
+        public bool Register()
+        {
+            if (registered.ContainsKey(Id))
+                return false;
+
+            registered.Add(Id, (T)(object)this);
+
+            IsRegistered = true;
+
+            OnRegistered();
+            return true;
+        }
+
+        /// <summary>
+        /// Unregisters this custom object.
+        /// </summary>
+        /// <returns>true if the object got unregistered</returns>
+        public bool Unregister()
+        {
+            if (!registered.Remove(Id))
+                return false;
+
+            IsRegistered = false;
+
+            OnUnregistered();
+            return true;
+        }
+
+        /// <summary>
+        /// Gets called after being registered.
+        /// </summary>
+        public virtual void OnRegistered()
+        {
+
+        }
+
+        /// <summary>
+        /// Gets called after being unregistered.
+        /// </summary>
+        public virtual void OnUnregistered()
+        {
+
+        }
+    }
+}

LabExtended/API/Custom/Items/CustomItem.cs

@@ -31,7 +31,7 @@ namespace LabExtended.API.Custom.Items
     /// <summary>
     /// Base class for custom item implementations.
     /// </summary>
-    public abstract class CustomItem
+    public abstract class CustomItem : CustomObject<CustomItem>
     {
         #region Delegates
         /// <summary>
@@ -80,14 +80,8 @@ public abstract class CustomItem
         public delegate void ForEachPickupDelegate<T>(ItemPickupBase item, ref T? itemData);
         #endregion
 
-        internal static Dictionary<string, CustomItem> itemsById = new();
         internal static Dictionary<ushort, TrackedCustomItem> itemsBySerial = new();
 
-        /// <summary>
-        /// Gets all registered custom items.
-        /// </summary>
-        public static IReadOnlyDictionary<string, CustomItem> RegisteredItems => itemsById;
-
         /// <summary>
         /// Gets all tracked custom items.
         /// </summary>
@@ -269,12 +263,6 @@ public static bool IsCustomItem<TItem, TData>(ushort itemSerial, out TItem custo
         public static bool IsTrackedItem(ushort itemSerial, out TrackedCustomItem trackedItem)
             => itemsBySerial.TryGetValue(itemSerial, out trackedItem);
 
-        /// <summary>
-        /// Gets the ID of the custom item.
-        /// </summary>
-        [YamlIgnore]
-        public abstract string Id { get; }
-
         /// <summary>
         /// Gets the name of the custom item.
         /// </summary>
@@ -318,46 +306,6 @@ public static bool IsTrackedItem(ushort itemSerial, out TrackedCustomItem tracke
         [Description("Sets if custom items dropped by a player should be destroyed when the player who dropped them leaves.")]
         public virtual bool DestroyOnOwnerLeave { get; set; } = false;
 
-        /// <summary>
-        /// Registers this custom item.
-        /// </summary>
-        /// <returns>true if the item was registered</returns>
-        public bool Register()
-        {
-            if (itemsById.ContainsKey(Id))
-                return false;
-
-            itemsById.Add(Id, this);
-
-            Registered?.Invoke(this);
-
-            OnRegistered();
-
-            ApiLog.Info("Custom Items", $"&2Registered&r custom item &3{Name}&r (&6{Id}&r)");
-            return true;
-        }
-
-        /// <summary>
-        /// Unregisters this custom item and removes all active instances.
-        /// </summary>
-        /// <returns></returns>
-        public bool Unregister()
-        {
-            if (itemsById.Remove(Id))
-            {
-                DestroyInstances();
-
-                Unregistered?.Invoke(this);
-
-                OnUnregistered();
-
-                ApiLog.Info("Custom Items", $"&1Unregistered&r custom item &3{Name}&r (&6{Id}&r)");
-                return true;
-            }
-
-            return false;
-        }
-
         /// <summary>
         /// Invokes the specified delegate for each item currently held by a valid tracker and its associated owner.
         /// </summary>
@@ -1299,12 +1247,24 @@ public virtual void OnCollided(PickupCollidedEventArgs args, ref object? pickupD
         /// <summary>
         /// Gets called once the item has been registered.
         /// </summary>
-        public virtual void OnRegistered() { }
+        public override void OnRegistered()
+        {
+            Registered?.InvokeSafe(this);
+
+            ApiLog.Info("Custom Items", $"&2Registered&r custom item &3{Name}&r (&6{Id}&r)");
+        }
 
         /// <summary>
         /// Gets called once the item has been unregistered.
         /// </summary>
-        public virtual void OnUnregistered() { }
+        public override void OnUnregistered()
+        {
+            DestroyInstances();
+
+            Unregistered?.InvokeSafe(this);
+
+            ApiLog.Info("Custom Items", $"&1Unregistered&r custom item &3{Name}&r (&6{Id}&r)");
+        }
 
         /// <summary>
         /// Called when an item is added to a player -or- when the player picks up a spawned pickup.

LabExtended/Commands/Custom/CustomItems/CustomItemsCommand.cs

@@ -102,15 +102,17 @@ public void Inventory(
         [CommandOverload("list", "Lists all registered custom items.")]
         public void List()
         {
-            if (CustomItem.RegisteredItems.Count == 0)
+            if (CustomItem.RegisteredObjects.Count == 0)
             {
                 Fail($"No items have been registered.");
                 return;
             }
 
             Ok(x =>
             {
-                foreach (var pair in CustomItem.RegisteredItems)
+                x.AppendLine();
+
+                foreach (var pair in CustomItem.RegisteredObjects)
                 {
                     var type = pair.Value.GetType();
                     var baseType = type.BaseType ?? type;
@@ -126,15 +128,17 @@ public void List()
         [CommandOverload("active", "Lists all active custom item instances.")]
         public void Active()
         {
-            if (CustomItem.RegisteredItems.Count == 0)
+            if (CustomItem.RegisteredObjects.Count == 0)
             {
                 Fail($"No items have been registered.");
                 return;
             }
 
             Ok(x =>
             {
-                foreach (var pair in CustomItem.RegisteredItems)
+                x.AppendLine();
+
+                foreach (var pair in CustomItem.RegisteredObjects)
                 {
                     var baseType = pair.Value.GetType().BaseType ?? pair.Value.GetType();
 
@@ -184,7 +188,7 @@ public void Active()
         public void Destroy(
             [CommandParameter("Serial", "The serial number of the item to destroy. Specify 0 to destroy all.")] ushort itemSerial)
         {
-            if (CustomItem.RegisteredItems.Count == 0)
+            if (CustomItem.RegisteredObjects.Count == 0)
             {
                 Fail($"No items have been registered.");
                 return;
@@ -196,7 +200,7 @@ public void Destroy(
                 {
                     x.AppendLine();
 
-                    foreach (var pair in CustomItem.RegisteredItems)
+                    foreach (var pair in CustomItem.RegisteredObjects)
                         x.AppendLine($"- [ID: {pair.Key}] {pair.Value.Name}; {pair.Value.DestroyInstances()} instance(s) destroyed!");
                 });
             }
@@ -249,19 +253,20 @@ public void Destroy(
         /// Adds a custom item to a player's inventory.
         /// </summary>
         [CommandOverload("add", "Adds a custom item to a player's inventory.")]
+        [CommandOverload("give", "Adds a custom item to a player's inventory.")]
         public void Add(
             [CommandParameter("ID", "The ID of the custom item to add.")] string itemId,
             [CommandParameter("Target", "The player to add the item to (defaults to you).")] ExPlayer? target = null)
         {
             target ??= Sender;
 
-            if (CustomItem.RegisteredItems.Count == 0)
+            if (CustomItem.RegisteredObjects.Count == 0)
             {
                 Fail($"No items have been registered.");
                 return;
             }
 
-            if (!CustomItem.RegisteredItems.TryGetValue(itemId, out var customItem))
+            if (!CustomItem.RegisteredObjects.TryGetValue(itemId, out var customItem))
             {
                 Fail($"Unknown custom item ID");
                 return;
@@ -287,13 +292,13 @@ public void Spawn(
             [CommandParameter("ID", "The ID of the custom item to spawn.")] string itemId,
             [CommandParameter("Position", "The position to spawn the item at.")] Vector3 position)
         {
-            if (CustomItem.RegisteredItems.Count == 0)
+            if (CustomItem.RegisteredObjects.Count == 0)
             {
                 Fail($"No items have been registered.");
                 return;
             }
 
-            if (!CustomItem.RegisteredItems.TryGetValue(itemId, out var customItem))
+            if (!CustomItem.RegisteredObjects.TryGetValue(itemId, out var customItem))
             {
                 Fail($"Unknown custom item ID");
                 return;