feat: get product properties

Author: omar-akermi

S1API/Products/CocaineDefinition.cs

@@ -6,34 +6,57 @@
 using S1CocaineDefinition = ScheduleOne.Product.CocaineDefinition;
 #endif
 
+using System.Collections.Generic;
 using S1API.Internal.Utils;
 using S1API.Items;
 
 namespace S1API.Products
 {
     /// <summary>
-    /// Represents the definition of a Cocaine product.
+    /// Represents the definition of a cocaine product within the system.
     /// </summary>
     public class CocaineDefinition : ProductDefinition
     {
         /// <summary>
-        /// INTERNAL: Strongly typed access to the CocaineDefinition.
+        /// INTERNAL: Strongly typed access to the CocaineDefinition within the Schedule One framework.
         /// </summary>
         internal S1CocaineDefinition S1CocaineDefinition =>
             CrossType.As<S1CocaineDefinition>(S1ItemDefinition);
 
         /// <summary>
-        /// Creates a new cocaine product definition.
+        /// Represents the definition of a Cocaine product.
         /// </summary>
-        /// <param name="definition">The original in-game cocaine definition.</param>
         internal CocaineDefinition(S1CocaineDefinition definition)
-            : base(definition) { }
+            : base(definition)
+        {
+        }
 
         /// <summary>
-        /// Creates an instance of this cocaine product.
+        /// Creates an instance of this cocaine product with the specified quantity.
         /// </summary>
+        /// <param name="quantity">The quantity of the product to create. Defaults to 1.</param>
+        /// <returns>An instance of the cocaine product with the specified quantity.</returns>
         public override ItemInstance CreateInstance(int quantity = 1) =>
             new ProductInstance(CrossType.As<ProductItemInstance>(
                 S1CocaineDefinition.GetDefaultInstance(quantity)));
+
+        /// <summary>
+        /// Retrieves a list of properties associated with the current cocaine product definition.
+        /// </summary>
+        /// <returns>A list of properties specific to the cocaine product definition.</returns>
+        public List<Il2CppScheduleOne.Properties.Property> GetProperties()
+        {
+            var result = new List<Il2CppScheduleOne.Properties.Property>();
+            var list = S1CocaineDefinition?.Properties;
+            if (list != null)
+            {
+                for (int i = 0; i < list.Count; i++)
+                {
+                    result.Add(list[i]);
+                }
+            }
+            return result;
+        }
     }
+
 }

S1API/Products/MethDefinition.cs

@@ -6,34 +6,60 @@
 using S1MethDefinition = ScheduleOne.Product.MethDefinition;
 #endif
 
+using System.Collections.Generic;
 using S1API.Internal.Utils;
 using S1API.Items;
 
 namespace S1API.Products
 {
     /// <summary>
-    /// Represents the definition of a Meth product.
+    /// Represents the definition of a Meth product in the product framework.
     /// </summary>
+    /// <remarks>
+    /// Provides methods for retrieving properties and creating instances of meth products. This class extends the base functionality provided by <see cref="ProductDefinition"/>.
+    /// </remarks>
     public class MethDefinition : ProductDefinition
     {
         /// <summary>
-        /// INTERNAL: Strongly typed access to the MethDefinition.
+        /// INTERNAL: Strongly typed access to S1MethDefinition, representing the Il2CppScheduleOne.Product.MethDefinition entity.
         /// </summary>
         internal S1MethDefinition S1MethDefinition =>
             CrossType.As<S1MethDefinition>(S1ItemDefinition);
 
         /// <summary>
-        /// Creates a new meth product definition.
+        /// Represents the definition of a Meth product.
         /// </summary>
-        /// <param name="definition">The original in-game meth definition.</param>
         internal MethDefinition(S1MethDefinition definition)
-            : base(definition) { }
+            : base(definition)
+        {
+        }
 
         /// <summary>
-        /// Creates an instance of this meth product.
+        /// Creates an instance of this meth product with a specified quantity.
         /// </summary>
+        /// <param name="quantity">The quantity of the meth product to instantiate. Defaults to 1 if not provided.</param>
+        /// <returns>An instance of the meth product as a <see cref="ItemInstance"/>.</returns>
         public override ItemInstance CreateInstance(int quantity = 1) =>
             new ProductInstance(CrossType.As<ProductItemInstance>(
                 S1MethDefinition.GetDefaultInstance(quantity)));
+
+        /// <summary>
+        /// Retrieves the list of properties associated with the meth product definition.
+        /// </summary>
+        /// <returns>A list of properties that belong to the meth product definition.</returns>
+        public List<Il2CppScheduleOne.Properties.Property> GetProperties()
+        {
+            var result = new List<Il2CppScheduleOne.Properties.Property>();
+            var list = S1MethDefinition?.Properties;
+            if (list != null)
+            {
+                for (int i = 0; i < list.Count; i++)
+                {
+                    result.Add(list[i]);
+                }
+            }
+
+            return result;
+        }
     }
 }

S1API/Products/ProductDefinition.cs

@@ -5,6 +5,7 @@
 using S1Product = ScheduleOne.Product;
 #endif
 
+using System.Collections.Generic;
 using S1API.Internal.Utils;
 using S1API.Items;
 using UnityEngine;
@@ -26,7 +27,7 @@ public class ProductDefinition : ItemDefinition
         /// INTERNAL: Creates a product definition from the in-game product definition.
         /// </summary>
         /// <param name="productDefinition"></param>
-        internal ProductDefinition(S1Product.ProductDefinition productDefinition) : base(productDefinition) { }
+        internal ProductDefinition(Il2CppScheduleOne.ItemFramework.ItemDefinition productDefinition) : base(productDefinition) { }
 
         /// <summary>
         /// The price associated with this product.
@@ -50,5 +51,9 @@ public Sprite Icon
             get { return S1ProductDefinition.Icon; }
         }
 
-    }
+    private List<Properties.Property> properties; // or however properties are stored
+
+    // Add this public property if it doesn't exist yet
+    public IReadOnlyList<Properties.Property> Properties => properties.AsReadOnly();
+}
 }

S1API/Products/ProductDefinitionWrapper.cs

@@ -2,26 +2,35 @@
 
 #if (IL2CPPMELON || IL2CPPBEPINEX)
 using S1Product = Il2CppScheduleOne.Product;
+
 #else
 using S1Product = ScheduleOne.Product;
 #endif
 
 namespace S1API.Products
 {
     /// <summary>
-    /// INTERNAL: A wrapper class for converting a product definition to its proper dedicated class.
+    /// Provides functionality to wrap and convert generic product definitions into their specific type-derived definitions.
     /// </summary>
-    internal static class ProductDefinitionWrapper
+    public static class ProductDefinitionWrapper
     {
-        internal static ProductDefinition Wrap(ProductDefinition def)
+        /// <summary>
+        /// Converts a generic <see cref="ProductDefinition"/> into its corresponding typed wrapper.
+        /// </summary>
+        /// <param name="def">The raw product definition to be processed and converted.</param>
+        /// <returns>A wrapped instance of <see cref="ProductDefinition"/> with type-specific methods and properties, or the input definition if no specific wrapper applies.</returns>
+        public static ProductDefinition Wrap(ProductDefinition def)
         {
             var item = def.S1ItemDefinition;
             if (CrossType.Is<S1Product.WeedDefinition>(item, out var weed))
                 return new WeedDefinition(weed);
+
             if (CrossType.Is<S1Product.MethDefinition>(item, out var meth))
                 return new MethDefinition(meth);
+
             if (CrossType.Is<S1Product.CocaineDefinition>(item, out var coke))
                 return new CocaineDefinition(coke);
+
             return def;
         }
     }

S1API/Products/ProductInstance.cs

@@ -7,6 +7,7 @@
 using ScheduleOne.ItemFramework;
 #endif
 
+using System.Collections.Generic;
 using S1API.Internal.Utils;
 using ItemInstance = S1API.Items.ItemInstance;
 
@@ -27,7 +28,9 @@ public class ProductInstance : ItemInstance
         /// INTERNAL: Creates a product instance from the in-game product instance.
         /// </summary>
         /// <param name="productInstance"></param>
-        internal ProductInstance(S1Product.ProductItemInstance productInstance) : base(productInstance) { }
+        internal ProductInstance(S1Product.ProductItemInstance productInstance) : base(productInstance)
+        {
+        }
 
         /// <summary>
         /// Whether this product is currently packaged or not.
@@ -40,12 +43,16 @@ internal ProductInstance(S1Product.ProductItemInstance productInstance) : base(p
         /// </summary>
         public PackagingDefinition AppliedPackaging =>
             new PackagingDefinition(S1ProductInstance.AppliedPackaging);
+
         /// <summary>
         /// The quality of this product instance.
         /// </summary>
         public Quality Quality => S1ProductInstance.Quality.ToAPI();
 
+        // Expose the underlying definition's properties (if S1ProductInstance.Definition is available)
+        public IReadOnlyList<Properties.Property> Properties => Definition.Properties;
 
+        // Add Definition property if you don't have one yet
+        public ProductDefinition Definition => new ProductDefinition(S1ProductInstance.Definition);
     }
-
 }

S1API/Products/WeedDefinition.cs

@@ -8,33 +8,69 @@
 
 using S1API.Internal.Utils;
 using S1API.Items;
+using System.Collections.Generic;
 
 namespace S1API.Products
 {
     /// <summary>
-    /// Represents the definition of a Weed product.
+    /// Represents a specific type of weed product definition. This class extends the functionality of
+    /// <see cref="ProductDefinition"/> to include details specific to weed products.
     /// </summary>
+    /// <remarks>
+    /// This class provides methods and properties to work with weed-related product definitions,
+    /// including creating product instances and accessing weed-specific properties.
+    /// </remarks>
     public class WeedDefinition : ProductDefinition
     {
         /// <summary>
-        /// INTERNAL: Strongly typed access to the WeedDefinition.
+        /// Represents the definition of a weed product in the ScheduleOne API.
+        /// Provides access to underlying data and functionalities specific to weed products.
         /// </summary>
         internal S1WeedDefinition S1WeedDefinition =>
             CrossType.As<S1WeedDefinition>(S1ItemDefinition);
 
-
         /// <summary>
-        /// Creates a new weed product definition.
+        /// Represents a specific type of product definition for weed products in the API.
         /// </summary>
-        /// <param name="definition">The original in-game weed definition.</param>
+        /// <remarks>
+        /// This class acts as a wrapper for `Il2CppScheduleOne.Product.WeedDefinition`,
+        /// providing additional functionality and a specific type for handling weed items.
+        /// </remarks>
         internal WeedDefinition(S1WeedDefinition definition)
-            : base(definition) { }
+            : base(definition)
+        {
+        }
 
         /// <summary>
-        /// Creates an instance of this weed product.
+        /// Creates an instance of the product with the specified quantity.
         /// </summary>
+        /// <param name="quantity">The quantity of the product to create. Defaults to 1 if not specified.</param>
+        /// <returns>An instance of <see cref="ItemInstance"/> representing the created product.</returns>
         public override ItemInstance CreateInstance(int quantity = 1) =>
             new ProductInstance(CrossType.As<ProductItemInstance>(
                 S1WeedDefinition.GetDefaultInstance(quantity)));
+
+        /// <summary>
+        /// Gets a list of properties associated with the current weed definition.
+        /// </summary>
+        /// <returns>
+        /// A list of properties of type Il2CppScheduleOne.Properties.Property
+        /// associated with the weed definition. If no properties are found,
+        /// an empty list is returned.
+        /// </returns>
+        public List<Il2CppScheduleOne.Properties.Property> GetProperties()
+        {
+            var result = new List<Il2CppScheduleOne.Properties.Property>();
+            var list = S1WeedDefinition?.Properties;
+            if (list != null)
+            {
+                for (int i = 0; i < list.Count; i++)
+                {
+                    result.Add(list[i]);
+                }
+            }
+
+            return result;
+        }
     }
 }