PaperMC/patches/api/0448-Add-experience-points-API.patch
Nassim Jahnke 71c84c8132
Updated Upstream (Bukkit/CraftBukkit/Spigot) (#10277)
Upstream has released updates that appear to apply and compile correctly.
This update has not been tested by PaperMC and as with ANY update, please do your own testing

Bukkit Changes:
9a80d38c SPIGOT-336, SPIGOT-3366, SPIGOT-5768, SPIGOT-6409, SPIGOT-6861, PR-722: Add EntityRemoveEvent
258086d9 SPIGOT-7417, PR-967: Add Sign#getTargetSide and Sign#getAllowedEditor
ffaba051 SPIGOT-7584: Add missing Tag.ITEMS_NON_FLAMMABLE_WOOD

CraftBukkit Changes:
98b6c1ac7 SPIGOT-7589 Fix NullPointerException when bans expire
a2736ddb0 SPIGOT-336, SPIGOT-3366, SPIGOT-5768, SPIGOT-6409, SPIGOT-6861, PR-1008: Add EntityRemoveEvent
5bf12cb89 SPIGOT-7565: Throw a more descriptive error message when a developer tries to spawn an entity from a CraftBukkit class
76d95fe7e SPIGOT-7417, PR-1343: Add Sign#getTargetSide and Sign#getAllowedEditor

Spigot Changes:
e9ec5485 Rebuild patches
f1b62e0c Rebuild patches
2024-02-23 14:37:33 +01:00

56 lines
2.5 KiB
Diff

From 0000000000000000000000000000000000000000 Mon Sep 17 00:00:00 2001
From: Lukas Planz <lukas.planz@web.de>
Date: Tue, 5 Sep 2023 20:33:52 +0200
Subject: [PATCH] Add experience points API
diff --git a/src/main/java/org/bukkit/entity/Player.java b/src/main/java/org/bukkit/entity/Player.java
index 5bad312df63eb6dea705c35e0f7e4dd980f526d7..254a02ddb5dc867c9dd6c2086791f7ab94247fd3 100644
--- a/src/main/java/org/bukkit/entity/Player.java
+++ b/src/main/java/org/bukkit/entity/Player.java
@@ -1834,6 +1834,45 @@ public interface Player extends HumanEntity, Conversable, OfflinePlayer, PluginM
* @param exp New total experience points
*/
public void setTotalExperience(int exp);
+ // Paper start
+ /**
+ * Gets the players total amount of experience points he collected to reach the current level and level progress.
+ *
+ * <p>This method differs from {@link #getTotalExperience()} in that this method always returns an
+ * up-to-date value that reflects the players{@link #getLevel() level} and {@link #getExp() level progress}</p>
+ *
+ * @return Current total experience points
+ * @see #getLevel()
+ * @see #getExp()
+ * @see #setExperienceLevelAndProgress(int)
+ */
+ @org.jetbrains.annotations.Range(from = 0, to = Integer.MAX_VALUE) int calculateTotalExperiencePoints();
+
+ /**
+ * Updates the players level and level progress to that what would be reached when the total amount of experience
+ * had been collected.
+ *
+ * <p>This method differs from {@link #setTotalExperience(int)} in that this method actually updates the
+ * {@link #getLevel() level} and {@link #getExp() level progress} so that a subsequent call of
+ * {@link #calculateTotalExperiencePoints()} yields the same amount of points that have been set</p>
+ *
+ * @param totalExperience New total experience points
+ * @see #setLevel(int)
+ * @see #setExp(float)
+ * @see #calculateTotalExperiencePoints()
+ */
+ void setExperienceLevelAndProgress(@org.jetbrains.annotations.Range(from = 0, to = Integer.MAX_VALUE) int totalExperience);
+
+ /**
+ * Gets the total amount of experience points that are needed to reach the next level from zero progress towards it.
+ *
+ * <p>Can be used with {@link #getExp()} to calculate the current points for the current level and alike</p>
+ *
+ * @return The required experience points
+ * @see #getExp()
+ */
+ int getExperiencePointsNeededForNextLevel();
+ // Paper end
/**
* Send an experience change.