mirrors/papermc
2
0
Fork 0
Code Issues Pull requests Projects Releases Packages Wiki Activity Actions
papermc/Spigot-API-Patches/0181-PlayerDeathEvent-getItemsToKeep.patch

58 lines
2.4 KiB
Diff
Raw Normal View History

fix javadocs
2019-03-29 03:58:09 +00:00
From ef529fe9d2cdb0ba907c3c953e1f09b18492b244 Mon Sep 17 00:00:00 2001
PlayerDeathEvent#getItemsToKeep Exposes a mutable array on items a player should keep on death. This allows a cleaner method to implement "Keep certain items on death" than how plugins currently do it in that it never removes them in first place, so its safe if the player logs out/server is shutdown before respawn. Example Usage: https://gist.github.com/aikar/5bb202de6057a051a950ce1f29feb0b4
2019-03-28 04:58:05 +00:00
From: Aikar <aikar@aikar.co>
Date: Mon, 11 Mar 2013 20:04:34 -0400
Subject: [PATCH] PlayerDeathEvent#getItemsToKeep
Exposes a mutable array on items a player should keep on death
Example Usage: https://gist.github.com/aikar/5bb202de6057a051a950ce1f29feb0b4
diff --git a/src/main/java/org/bukkit/event/entity/PlayerDeathEvent.java b/src/main/java/org/bukkit/event/entity/PlayerDeathEvent.java
fix javadocs
2019-03-29 03:58:09 +00:00
index 5b0ef1eb..c96815a4 100644
PlayerDeathEvent#getItemsToKeep Exposes a mutable array on items a player should keep on death. This allows a cleaner method to implement "Keep certain items on death" than how plugins currently do it in that it never removes them in first place, so its safe if the player logs out/server is shutdown before respawn. Example Usage: https://gist.github.com/aikar/5bb202de6057a051a950ce1f29feb0b4
2019-03-28 04:58:05 +00:00
--- a/src/main/java/org/bukkit/event/entity/PlayerDeathEvent.java
+++ b/src/main/java/org/bukkit/event/entity/PlayerDeathEvent.java
Reuse buffers for chunk compression to optimize memory use Instead of allocating a buffer for every chunk compression, reuse the same 64k sized buffer. Also stopped doing dynamic compression levels. It wasn't helping enough. This will improve memory usage and zlib performance of chunk compression.
2019-03-29 02:06:35 +00:00
@@ -18,6 +18,40 @@ public class PlayerDeathEvent extends EntityDeathEvent {
PlayerDeathEvent#getItemsToKeep Exposes a mutable array on items a player should keep on death. This allows a cleaner method to implement "Keep certain items on death" than how plugins currently do it in that it never removes them in first place, so its safe if the player logs out/server is shutdown before respawn. Example Usage: https://gist.github.com/aikar/5bb202de6057a051a950ce1f29feb0b4
2019-03-28 04:58:05 +00:00
private boolean keepLevel = false;
private boolean keepInventory = false;
+ // Paper start
+ private List<ItemStack> itemsToKeep = new java.util.ArrayList<>();
+
+ /**
Reuse buffers for chunk compression to optimize memory use Instead of allocating a buffer for every chunk compression, reuse the same 64k sized buffer. Also stopped doing dynamic compression levels. It wasn't helping enough. This will improve memory usage and zlib performance of chunk compression.
2019-03-29 02:06:35 +00:00
+ * A mutable collection to add items that the player should retain in their inventory on death (Similar to KeepInventory game rule)
PlayerDeathEvent#getItemsToKeep Exposes a mutable array on items a player should keep on death. This allows a cleaner method to implement "Keep certain items on death" than how plugins currently do it in that it never removes them in first place, so its safe if the player logs out/server is shutdown before respawn. Example Usage: https://gist.github.com/aikar/5bb202de6057a051a950ce1f29feb0b4
2019-03-28 04:58:05 +00:00
+ *
+ * You <b>MUST</b> remove the item from the .getDrops() collection too or it will duplicate!
fix javadocs
2019-03-29 03:58:09 +00:00
+ * <pre>{@code
+ * @literal @EventHandler(ignoreCancelled = true)
Reuse buffers for chunk compression to optimize memory use Instead of allocating a buffer for every chunk compression, reuse the same 64k sized buffer. Also stopped doing dynamic compression levels. It wasn't helping enough. This will improve memory usage and zlib performance of chunk compression.
2019-03-29 02:06:35 +00:00
+ * public void onPlayerDeath(PlayerDeathEvent event) {
+ * for (Iterator<ItemStack> iterator = event.getDrops().iterator(); iterator.hasNext(); ) {
+ * ItemStack drop = iterator.next();
+ * List<String> lore = drop.getLore();
+ * if (lore != null && !lore.isEmpty()) {
+ * if (lore.get(0).contains("(SOULBOUND)")) {
+ * iterator.remove();
+ * event.getItemsToKeep().add(drop);
+ * }
+ * }
+ * }
+ * }
fix javadocs
2019-03-29 03:58:09 +00:00
+ * }</pre>
Reuse buffers for chunk compression to optimize memory use Instead of allocating a buffer for every chunk compression, reuse the same 64k sized buffer. Also stopped doing dynamic compression levels. It wasn't helping enough. This will improve memory usage and zlib performance of chunk compression.
2019-03-29 02:06:35 +00:00
+ *
+ * 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"
PlayerDeathEvent#getItemsToKeep Exposes a mutable array on items a player should keep on death. This allows a cleaner method to implement "Keep certain items on death" than how plugins currently do it in that it never removes them in first place, so its safe if the player logs out/server is shutdown before respawn. Example Usage: https://gist.github.com/aikar/5bb202de6057a051a950ce1f29feb0b4
2019-03-28 04:58:05 +00:00
+ *
+ * @return The list to hold items to keep
+ */
+ @NotNull
+ public List<ItemStack> getItemsToKeep() {
+ return itemsToKeep;
+ }
+ // Paper end
+
public PlayerDeathEvent(@NotNull final Player player, @NotNull final List<ItemStack> drops, final int droppedExp, @Nullable final String deathMessage) {
this(player, drops, droppedExp, 0, deathMessage);
}
--
2.21.0
Reference in a new issue Copy permalink