1.3

Implemented rebirths api

Author: Jan Kluka

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

@@ -14,6 +14,7 @@
 import dev.drawethree.xprison.api.pickaxeskins.XPrisonPickaxeSkinsAPI;
 import dev.drawethree.xprison.api.prestiges.XPrisonPrestigesAPI;
 import dev.drawethree.xprison.api.ranks.XPrisonRanksAPI;
+import dev.drawethree.xprison.api.rebirth.XPrisonRebirthAPI;
 import org.jetbrains.annotations.NotNull;
 
 /**
@@ -133,6 +134,14 @@ public interface XPrisonAPI {
     @NotNull
     XPrisonPickaxeSkinsAPI getPickaxeSkinsApi();
 
+    /**
+     * Gets the Rebirth API
+     *
+     * @return the Rebirth API instance
+     */
+    @NotNull
+    XPrisonRebirthAPI getRebirthApi();
+
     /**
      * Gets the singleton instance of the XPrisonAPI.
      *

src/main/java/dev/drawethree/xprison/api/currency/enums/LostCause.java

@@ -25,6 +25,11 @@ public enum LostCause {
 	 */
 	RANKUP,
 
+	/**
+	 * Player lost currency by rebirth.
+	 */
+	REBIRTH,
+
 	/**
 	 * Player lost currency by an admin running a command affecting currency.
 	 */

src/main/java/dev/drawethree/xprison/api/currency/event/PlayerCurrencyReceiveEvent.java

@@ -52,7 +52,7 @@ public final class PlayerCurrencyReceiveEvent extends XPrisonPlayerEvent impleme
 	 * @param player the {@link OfflinePlayer} receiving the currency
 	 * @param amount the amount of currency to be received
 	 */
-	public PlayerCurrencyReceiveEvent(XPrisonCurrency currency, ReceiveCause cause, OfflinePlayer player, long amount) {
+	public PlayerCurrencyReceiveEvent(XPrisonCurrency currency, ReceiveCause cause, OfflinePlayer player, double amount) {
 		super(player);
 		this.currency = currency;
 		this.cause = cause;

src/main/java/dev/drawethree/xprison/api/multipliers/XPrisonMultipliersAPI.java

@@ -25,20 +25,4 @@ public interface XPrisonMultipliersAPI {
 	 */
 	PlayerMultiplier getPlayerMultiplier(Player p, XPrisonCurrency currency);
 
-
-	/**
-	 * Calculates the total amount to deposit after applying the player's multiplier.
-	 *
-	 * @param p       the player
-	 * @param deposit the original amount to deposit
-	 * @param currency    the currency affected
-	 * @return the new amount to deposit after applying multiplier
-	 */
-	default double getTotalToDeposit(Player p, double deposit, XPrisonCurrency currency) {
-		PlayerMultiplier multiplier = this.getPlayerMultiplier(p, currency);
-		if (multiplier == null) {
-			return deposit;
-		}
-		return deposit * (1.0 + multiplier.getMultiplier());
-	}
 }

src/main/java/dev/drawethree/xprison/api/prestiges/XPrisonPrestigesAPI.java

@@ -48,4 +48,11 @@ public interface XPrisonPrestigesAPI {
 	 */
 	boolean isMaxPrestige(Player player);
 
+	/**
+	 * Resets a player's prestige to 0.
+	 *
+	 * @param player the player whose prestige will be reset
+	 */
+	void resetPlayerPrestige(Player player);
+
 }

src/main/java/dev/drawethree/xprison/api/rebirth/XPrisonRebirthAPI.java

@@ -0,0 +1,68 @@
+package dev.drawethree.xprison.api.rebirth;
+
+import dev.drawethree.xprison.api.rebirth.model.Rebirth;
+import org.bukkit.entity.Player;
+
+import java.util.Optional;
+
+/**
+ * API interface for interacting with the XPrison Rebirth system.
+ */
+public interface XPrisonRebirthAPI {
+
+	/**
+	 * Gets a rebirth by its unique ID.
+	 *
+	 * @param id the ID of the rebirth
+	 * @return the Rebirth corresponding to the given ID
+	 */
+	Rebirth getRebirthById(int id);
+
+	/**
+	 * Gets the current rebirth of a player.
+	 *
+	 * @param player the player whose rebirth is requested
+	 * @return the player's current Rebirth
+	 */
+	Rebirth getPlayerRebirth(Player player);
+
+	/**
+	 * Gets the next rebirth a player can achieve.
+	 *
+	 * @param player the player whose next rebirth is requested
+	 * @return an Optional containing the next Rebirth, or empty if the player has the max rebirth
+	 */
+	Optional<Rebirth> getNextPlayerRebirth(Player player);
+
+	/**
+	 * Sets a player's rebirth to the specified Rebirth.
+	 *
+	 * @param player  the player whose rebirth is to be set
+	 * @param rebirth the Rebirth to assign to the player
+	 */
+	void setPlayerRebirth(Player player, Rebirth rebirth);
+
+	/**
+	 * Resets a player's rebirth to the default rebirth (usually 0 or 1 depending on config).
+	 *
+	 * @param player the player whose rebirth will be reset
+	 */
+	void resetPlayerRebirth(Player player);
+
+	/**
+	 * Checks if a player currently holds the maximum possible rebirth.
+	 *
+	 * @param player the player to check
+	 * @return true if the player has the max rebirth, false otherwise
+	 */
+	boolean isMaxRebirth(Player player);
+
+	/**
+	 * Attempts to rebirth a player, checking all requirements.
+	 *
+	 * @param player the player attempting to rebirth
+	 * @return true if the rebirth was successful, false otherwise
+	 */
+	boolean tryRebirth(Player player);
+
+}

src/main/java/dev/drawethree/xprison/api/rebirth/events/PlayerRebirthEvent.java

@@ -0,0 +1,57 @@
+package dev.drawethree.xprison.api.rebirth.events;
+
+import dev.drawethree.xprison.api.rebirth.model.Rebirth;
+import dev.drawethree.xprison.api.shared.events.player.XPrisonPlayerEvent;
+import lombok.Getter;
+import lombok.Setter;
+import org.bukkit.entity.Player;
+import org.bukkit.event.Cancellable;
+import org.bukkit.event.HandlerList;
+
+/**
+ * Event fired when a player rebirths.
+ * <p>
+ * Contains information about the old rebirth and the new rebirth.
+ * This event is cancellable, allowing prevention of the rebirth.
+ */
+@Getter
+public final class PlayerRebirthEvent extends XPrisonPlayerEvent implements Cancellable {
+
+	private static final HandlerList handlers = new HandlerList();
+
+	private final Rebirth oldRebirth;
+
+	@Setter
+	private Rebirth newRebirth;
+
+	@Setter
+	private boolean cancelled;
+
+	/**
+	 * Constructs a new PlayerRebirthEvent.
+	 *
+	 * @param player Player who rebirth
+	 * @param oldR   The player's old rebirth
+	 * @param newR   The new rebirth the player is moving to
+	 */
+	public PlayerRebirthEvent(Player player, Rebirth oldR, Rebirth newR) {
+		super(player);
+		this.oldRebirth = oldR;
+		this.newRebirth = newR;
+	}
+
+	/**
+	 * Gets the HandlerList for this event.
+	 *
+	 * @return HandlerList instance
+	 */
+	public static HandlerList getHandlerList() {
+		return handlers;
+	}
+
+	@Override
+	public HandlerList getHandlers() {
+		return handlers;
+	}
+
+}

src/main/java/dev/drawethree/xprison/api/rebirth/model/Rebirth.java

@@ -0,0 +1,26 @@
+package dev.drawethree.xprison.api.rebirth.model;
+
+import java.util.List;
+
+public interface Rebirth {
+
+    /**
+     * @return The numeric ID of the rebirth (1, 2, 3, ...)
+     */
+    int getId();
+
+    /**
+     * @return The chat prefix for this rebirth.
+     */
+    String getPrefix();
+
+    /**
+     * @return All requirements needed to achieve this rebirth.
+     */
+    List<RebirthRequirement> getRequirements();
+
+    /**
+     * @return Commands to execute when the player reaches this rebirth.
+     */
+    List<String> getRewardCommands();
+}

src/main/java/dev/drawethree/xprison/api/rebirth/model/RebirthRequirement.java

@@ -0,0 +1,40 @@
+package dev.drawethree.xprison.api.rebirth.model;
+
+import org.bukkit.entity.Player;
+
+public interface RebirthRequirement {
+
+    /**
+     * @return a short type identifier, e.g. "rank", "prestige", "currency"
+     */
+    String getType();
+
+    /**
+     * @return Whether this requirement is enabled.
+     */
+    boolean isEnabled();
+
+    /**
+     * Checks if a player meets this requirement.
+     *
+     * @param player the player to check
+     * @return true if met
+     */
+    boolean isMet(Player player);
+
+    /**
+     * Applies the "payment" or consequence for this requirement after a rebirth happens.
+     * For example:
+     * - RANK → reset player rank to default
+     * - PRESTIGE → reset player prestige to default
+     * - CURRENCY → subtract balance
+     *
+     * @param player the player to apply the action to
+     */
+    void apply(Player player);
+
+    /**
+     * Returns the failure message to show the player when this requirement is not met.
+     */
+    String getFailMessage();
+}