1.2

Implemented Currency API

Author: Jan Kluka

pom.xml

@@ -4,7 +4,7 @@
 
   <groupId>dev.drawethree.xprison</groupId>
   <artifactId>X-PrisonAPI</artifactId>
-  <version>1.1</version>
+  <version>1.2-SNAPSHOT</version>
   <packaging>jar</packaging>
 
   <name>X-PrisonAPI</name>

src/main/java/dev/drawethree/xprison/api/XPrisonAPI.java

@@ -3,6 +3,7 @@
 import dev.drawethree.xprison.api.autominer.XPrisonAutoMinerAPI;
 import dev.drawethree.xprison.api.autosell.XPrisonAutoSellAPI;
 import dev.drawethree.xprison.api.bombs.XPrisonBombsAPI;
+import dev.drawethree.xprison.api.currency.XPrisonCurrencyAPI;
 import dev.drawethree.xprison.api.enchants.XPrisonEnchantsAPI;
 import dev.drawethree.xprison.api.gangs.XPrisonGangsAPI;
 import dev.drawethree.xprison.api.gems.XPrisonGemsAPI;
@@ -124,6 +125,14 @@ public interface XPrisonAPI {
     @NotNull
     XPrisonBombsAPI getBombsApi();
 
+    /**
+     * Gets the currency API.
+     *
+     * @return the Currency API instance
+     */
+    @NotNull
+    XPrisonCurrencyAPI getCurrencyApi();
+
     /**
      * Gets the singleton instance of the XPrisonAPI.
      *

src/main/java/dev/drawethree/xprison/api/blocks/XPrisonBlocksAPI.java

@@ -0,0 +1,9 @@
+package dev.drawethree.xprison.api.blocks;
+
+/**
+ * API interface for the AutoSell feature.
+ * Provides methods for managing selling blocks, pricing, and player earnings.
+ */
+public interface XPrisonBlocksAPI {
+
+}

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

@@ -0,0 +1,37 @@
+package dev.drawethree.xprison.api.currency;
+
+import dev.drawethree.xprison.api.shared.currency.enums.XPrisonCurrency;
+
+import java.util.Collection;
+
+/**
+ * API for interacting with XPrison's currency system.
+ * <p>
+ * Allows external plugins to register new currencies or retrieve existing ones.
+ */
+public interface XPrisonCurrencyAPI {
+
+    /**
+     * Registers a new custom currency to the system.
+     * <p>
+     * If a currency with the same name (case-insensitive) already exists, it will be overwritten.
+     *
+     * @param currency The {@link XPrisonCurrency} implementation to register.
+     */
+    void registerCurrency(XPrisonCurrency currency);
+
+    /**
+     * Retrieves a currency by its name.
+     *
+     * @param name The name of the currency (case-insensitive).
+     * @return The matching {@link XPrisonCurrency}, or null if not found.
+     */
+    XPrisonCurrency getCurrency(String name);
+
+    /**
+     * Returns all registered currencies.
+     *
+     * @return A collection of all {@link XPrisonCurrency} objects.
+     */
+    Collection<XPrisonCurrency> getAllCurrencies();
+}

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

@@ -1,6 +1,6 @@
 package dev.drawethree.xprison.api.enchants.model;
 
-import dev.drawethree.xprison.api.currency.CurrencyType;
+import dev.drawethree.xprison.api.shared.currency.enums.XPrisonCurrency;
 
 /**
  * Represents a custom enchantment in the XPrison system.
@@ -89,9 +89,12 @@ public interface XPrisonEnchantment {
     void unload();
 
     /**
-     * Gets the type of currency used to purchase this enchantment.
+     * Gets the currency used to purchase or upgrade this enchantment.
+     * <p>
+     * This defines which type of currency (e.g., Tokens, Gems, Vault/Money)
+     * will be consumed when a player interacts with this enchant.
      *
-     * @return The currency type (e.g., TOKENS, GEMS, VAULT).
+     * @return The {@link XPrisonCurrency} implementation representing the currency type.
      */
-    CurrencyType getCurrencyType();
+    XPrisonCurrency getCurrency();
 }

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

@@ -2,7 +2,8 @@
 
 import com.google.gson.JsonObject;
 import com.google.gson.JsonParser;
-import dev.drawethree.xprison.api.currency.CurrencyType;
+import dev.drawethree.xprison.api.XPrisonAPI;
+import dev.drawethree.xprison.api.shared.currency.enums.XPrisonCurrency;
 import dev.drawethree.xprison.api.utils.JsonUtils;
 import lombok.Getter;
 import lombok.Setter;
@@ -34,7 +35,7 @@ public abstract class XPrisonEnchantmentBase implements XPrisonEnchantment, Refu
     protected long baseCost;
     protected long increaseCost;
     protected XPrisonEnchantmentGuiProperties guiProperties;
-    protected CurrencyType currencyType;
+    protected XPrisonCurrency currencyType;
     protected boolean refundEnabled;
     protected int refundGuiSlot;
     protected double refundPercentage;
@@ -77,7 +78,7 @@ private void loadBaseProperties(JsonObject config) {
         this.maxLevel = JsonUtils.getRequiredInt(config,"maxLevel");
         this.baseCost = JsonUtils.getRequiredLong(config, "initialCost");
         this.increaseCost = JsonUtils.getRequiredLong(config,"increaseCostBy");
-        this.currencyType = CurrencyType.valueOf(JsonUtils.getOptionalString(config,"currency", CurrencyType.TOKENS.name()));
+        this.currencyType = XPrisonAPI.getInstance().getCurrencyApi().getCurrency(JsonUtils.getOptionalString(config,"currency", "Tokens"));
 
         JsonObject refundObject = JsonUtils.getRequiredObject(config,"refund");
         this.refundEnabled = JsonUtils.getRequiredBoolean(refundObject,"enabled");

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

@@ -4,44 +4,67 @@
 
 /**
  * Represents a generic currency system in the XPrison API.
+ * <p>
  * This interface abstracts common currency operations such as querying,
- * adding, removing, and setting amounts for players.
- *
- * Implementations could represent different currency types like Tokens, Gems, etc.
+ * adding, removing, and setting balances for players. Implementations
+ * could represent different currency types like Tokens, Gems, Money, etc.
+ * <p>
+ * Methods that modify balances return a boolean indicating whether the
+ * operation was successful (e.g., not blocked, not insufficient funds, etc.).
  */
 public interface XPrisonCurrency {
 
+    /**
+     * Gets the name of this currency.
+     * <p>
+     * This is typically used for display purposes, configuration keys,
+     * or to distinguish between multiple currency types (e.g., "Tokens", "Gems", "Money").
+     *
+     * @return The name of the currency.
+     */
+    String getName();
+
     /**
      * Gets the current amount of this currency for the specified player.
      *
      * @param player The player (offline or online) whose balance to retrieve.
      * @return The amount of currency the player currently has.
      */
-    long getAmount(OfflinePlayer player);
+    double getBalance(OfflinePlayer player);
 
     /**
      * Adds a specified amount of currency to the player's balance.
      *
      * @param player The player to add currency to.
      * @param amount The amount of currency to add.
-     * @param cause  The cause or reason for adding currency (e.g. mining, reward).
+     * @return true if the currency was successfully added, false otherwise.
      */
-    void add(OfflinePlayer player, long amount, ReceiveCause cause);
+    boolean addBalance(OfflinePlayer player, double amount);
 
     /**
      * Removes a specified amount of currency from the player's balance.
      *
      * @param player The player to remove currency from.
      * @param amount The amount of currency to remove.
-     * @param cause  The cause or reason for removing currency (e.g. purchase, penalty).
+     * @return true if the currency was successfully removed, false (e.g., insufficient funds) otherwise.
      */
-    void remove(OfflinePlayer player, long amount, LostCause cause);
+    boolean removeBalance(OfflinePlayer player, double amount);
 
     /**
      * Sets the player's currency balance to a new specified amount.
      *
      * @param player The player whose balance to set.
      * @param amount The new amount to set.
+     * @return true if the balance was successfully set, false otherwise.
+     */
+    boolean setBalance(OfflinePlayer player, double amount);
+
+    /**
+     * Checks if the specified player has at least the given amount of this currency.
+     *
+     * @param player The player whose balance to check.
+     * @param amount The minimum amount to verify.
+     * @return true if the player has at least the specified amount, false otherwise.
      */
-    void set(OfflinePlayer player, long amount);
+    boolean has(OfflinePlayer player, double amount);
 }