1.1-SNAPSHOT

Updated enchants api, added custom model data gui property and currency type for purchasing the enchant

Author: Jan Kluka

src/main/java/dev/drawethree/xprison/api/currency/CurrencyType.java

@@ -0,0 +1,5 @@
+package dev.drawethree.xprison.api.currency;
+
+public enum CurrencyType {
+    GEMS,TOKENS,VAULT
+}

src/main/java/dev/drawethree/xprison/api/enchants/model/XPrisonEnchantment.java

@@ -1,8 +1,10 @@
 package dev.drawethree.xprison.api.enchants.model;
 
+import dev.drawethree.xprison.api.currency.CurrencyType;
 
 /**
  * Represents a custom enchantment in the XPrison system.
+ * Each enchantment has a unique ID, name, configuration, and purchasing behavior.
  */
 public interface XPrisonEnchantment {
 
@@ -34,51 +36,62 @@ public interface XPrisonEnchantment {
      */
     String getNameWithoutColor();
 
+    /**
+     * Gets the GUI properties of this enchantment, such as material, slot, and description.
+     *
+     * @return The GUI properties of the enchantment.
+     */
     XPrisonEnchantmentGuiProperties getGuiProperties();
 
     /**
-     * Gets the author of this enchantment.
+     * Gets the name of the developer or plugin author who created this enchantment.
      *
      * @return The author name.
      */
     String getAuthor();
 
     /**
-     * Checks whether this enchantment is currently enabled.
+     * Checks whether this enchantment is currently enabled in the system.
      *
      * @return True if the enchantment is enabled, false otherwise.
      */
     boolean isEnabled();
 
     /**
-     * Gets the maximum enchantment level that can be applied.
+     * Gets the maximum level this enchantment can be upgraded to.
      *
-     * @return The maximum allowed level.
+     * @return The maximum allowed enchantment level.
      */
     int getMaxLevel();
 
     /**
-     * Gets the base cost of applying this enchantment.
+     * Gets the base cost of the enchantment, used as the starting cost for level 1.
      *
-     * @return The base cost.
+     * @return The base cost of applying the enchantment.
      */
     long getBaseCost();
 
     /**
-     * Gets the incremental cost added per level of this enchantment.
+     * Gets the amount by which the cost increases per level.
      *
-     * @return The increase in cost per level.
+     * @return The incremental cost per enchantment level.
      */
     long getIncreaseCost();
 
     /**
-     * Loads or initializes the enchantment from its configuration or internal state.
-     * Called when the enchantment is first created or reloaded.
+     * Initializes or loads this enchantment. Called during plugin load or reload.
      */
     void load();
 
     /**
-     * Unloads or disables the enchantment, freeing resources or unregistering listeners.
+     * Cleans up or unloads this enchantment. Called during plugin shutdown or reload.
      */
     void unload();
+
+    /**
+     * Gets the type of currency used to purchase this enchantment.
+     *
+     * @return The currency type (e.g., TOKENS, GEMS, VAULT).
+     */
+    CurrencyType getCurrencyType();
 }

src/main/java/dev/drawethree/xprison/api/enchants/model/XPrisonEnchantmentBase.java

@@ -3,6 +3,7 @@
 import com.google.gson.Gson;
 import com.google.gson.JsonObject;
 import com.google.gson.JsonParser;
+import dev.drawethree.xprison.api.currency.CurrencyType;
 import lombok.Getter;
 import lombok.Setter;
 import org.bukkit.ChatColor;
@@ -33,6 +34,7 @@ public abstract class XPrisonEnchantmentBase implements XPrisonEnchantment {
     protected long baseCost;
     protected long increaseCost;
     protected XPrisonEnchantmentGuiProperties guiProperties;
+    protected CurrencyType currencyType;
 
     /**
      * Constructs a new enchantment with the given config file.
@@ -72,6 +74,7 @@ private void loadBaseProperties(JsonObject config) {
         this.maxLevel = config.get("maxLevel").getAsInt();
         this.baseCost = config.get("initialCost").getAsLong();
         this.increaseCost = config.get("increaseCostBy").getAsLong();
+        this.currencyType = CurrencyType.valueOf(config.get("currency").getAsString());
     }
 
     /**
@@ -91,7 +94,9 @@ private void loadGuiProperties(JsonObject config) {
                 .map(s -> ChatColor.translateAlternateColorCodes('&', s))
                 .toList();
 
-        this.guiProperties = new XPrisonEnchantmentGuiPropertiesBase(slot, guiName, base64, mat, desc);
+        int customModelData = gui.get("customModelData").getAsInt();
+
+        this.guiProperties = new XPrisonEnchantmentGuiPropertiesBase(slot, guiName, base64, mat, desc,customModelData);
     }
 
     /**

src/main/java/dev/drawethree/xprison/api/enchants/model/XPrisonEnchantmentGuiProperties.java

@@ -42,4 +42,11 @@ public interface XPrisonEnchantmentGuiProperties {
      * @return The Base64 string for the GUI item texture, or null/empty if not applicable.
      */
     String getGuiBase64();
+
+    /**
+     * Gets the custom model data for the GUI item
+     *
+     * @return Custom Model Data of GUI item
+     */
+    int getCustomModelData();
 }

src/main/java/dev/drawethree/xprison/api/enchants/model/XPrisonEnchantmentGuiPropertiesBase.java

@@ -41,4 +41,9 @@ class XPrisonEnchantmentGuiPropertiesBase implements XPrisonEnchantmentGuiProper
      */
     private List<String> guiDescription;
 
+    /**
+     * Custom model data of the item (MC 1.14 and above)
+     */
+    private int customModelData;
+
 }