Package org.bukkit.event.player

Class PlayerItemConsumeEvent

java.lang.Object
org.bukkit.event.Event
org.bukkit.event.player.PlayerEvent
org.bukkit.event.player.PlayerItemConsumeEvent
All Implemented Interfaces:
Cancellable
public class PlayerItemConsumeEvent extends PlayerEvent implements Cancellable
This event will fire when a player is finishing consuming an item (food, potion, milk bucket).
If the ItemStack is modified the server will use the effects of the new item and not remove the original one from the player's inventory.
If the event is cancelled the effect will not be applied and the item will not be removed from the player's inventory.

  • Constructor Details

  • Method Details

    • getItem

      @NotNull public @NotNull ItemStack getItem()
      Gets the item that is being consumed. Modifying the returned item will have no effect, you must use setItem(org.bukkit.inventory.ItemStack) instead.
      Returns:
      an ItemStack for the item being consumed

    • setItem

      public void setItem​(@Nullable @Nullable ItemStack item)
      Set the item being consumed
      Parameters:
      item - the item being consumed

    • getReplacement

      @Nullable public @Nullable ItemStack getReplacement()
      Return the custom item stack that will replace the consumed item, or null if no custom replacement has been set (which means the default replacement will be used).
      Returns:
      The custom item stack that will replace the consumed item or null

    • setReplacement

      public void setReplacement​(@Nullable @Nullable ItemStack replacement)
      Set a custom item stack to replace the consumed item. Pass null to clear any custom stack that has been set and use the default replacement.
      Parameters:
      replacement - Replacement item to set, null to clear any custom stack and use default

    • isCancelled

      public boolean isCancelled()
      Description copied from interface: Cancellable
      Gets the cancellation state of this event. A cancelled event will not be executed in the server, but will still pass to other plugins
      Specified by:
      isCancelled in interface Cancellable
      Returns:
      true if this event is cancelled

    • setCancelled

      public void setCancelled​(boolean cancel)
      Description copied from interface: Cancellable
      Sets the cancellation state of this event. A cancelled event will not be executed in the server, but will still pass to other plugins.
      Specified by:
      setCancelled in interface Cancellable
      Parameters:
      cancel - true if you wish to cancel this event

    • getHandlers

      @NotNull public @NotNull HandlerList getHandlers()
      Specified by:
      getHandlers in class Event

    • getHandlerList

      @NotNull public static @NotNull HandlerList getHandlerList()