Commits

md_5 authored 70a529ba1f9
SPIGOT-6229: Clarify PlayerItemBreakEvent documentation
No tags

src/main/java/org/bukkit/event/player/PlayerItemBreakEvent.java

Modified
1 1 package org.bukkit.event.player;
2 2
3 3 import org.bukkit.entity.Player;
4 4 import org.bukkit.event.HandlerList;
5 5 import org.bukkit.inventory.ItemStack;
6 6 import org.jetbrains.annotations.NotNull;
7 7
8 8 /**
9 9 * Fired when a player's item breaks (such as a shovel or flint and steel).
10 10 * <p>
11 - * The item that's breaking will exist in the inventory with a stack size of
12 - * 0. After the event, the item's durability will be reset to 0.
11 + * After this event, the item's amount will be set to {@code item amount - 1}
12 + * and its durability will be reset to 0.
13 13 */
14 14 public class PlayerItemBreakEvent extends PlayerEvent {
15 15 private static final HandlerList handlers = new HandlerList();
16 16 private final ItemStack brokenItem;
17 17
18 18 public PlayerItemBreakEvent(@NotNull final Player player, @NotNull final ItemStack brokenItem) {
19 19 super(player);
20 20 this.brokenItem = brokenItem;
21 21 }
22 22

Everything looks good. We'll let you know here if there's anything you should know about.

Add shortcut