diff --git a/paper-api/src/main/java/org/bukkit/event/entity/PlayerDeathEvent.java b/paper-api/src/main/java/org/bukkit/event/entity/PlayerDeathEvent.java index 76f00e3861..edf14dac35 100644 --- a/paper-api/src/main/java/org/bukkit/event/entity/PlayerDeathEvent.java +++ b/paper-api/src/main/java/org/bukkit/event/entity/PlayerDeathEvent.java @@ -57,6 +57,41 @@ public class PlayerDeathEvent extends EntityDeathEvent { this.deathMessage = net.kyori.adventure.text.serializer.legacy.LegacyComponentSerializer.legacySection().deserializeOrNull(deathMessage); // Paper } + @Deprecated // Paper + // Paper start + private List itemsToKeep = new java.util.ArrayList<>(); + + /** + * A mutable collection to add items that the player should retain in their inventory on death (Similar to KeepInventory game rule) + * + * You MUST remove the item from the .getDrops() collection too or it will duplicate! + *
{@code
+     *    {@literal @EventHandler(ignoreCancelled = true)}
+     *     public void onPlayerDeath(PlayerDeathEvent event) {
+     *         for (Iterator iterator = event.getDrops().iterator(); iterator.hasNext(); ) {
+     *             ItemStack drop = iterator.next();
+     *             List lore = drop.getLore();
+     *             if (lore != null && !lore.isEmpty()) {
+     *                 if (lore.get(0).contains("(SOULBOUND)")) {
+     *                     iterator.remove();
+     *                     event.getItemsToKeep().add(drop);
+     *                 }
+     *             }
+     *         }
+     *     }
+     * }
+ * + * Adding an item to this list that the player did not previously have will give them the item on death. + * An example case could be a "Note" that "You died at X/Y/Z coordinates" + * + * @return The list to hold items to keep + */ + @NotNull + public List getItemsToKeep() { + return itemsToKeep; + } + // Paper end + @NotNull @Override public Player getEntity() {