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
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.
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.
-
Nested Class Summary
Nested classes/interfaces inherited from class org.bukkit.event.Event
Event.Result
-
Field Summary
Fields inherited from class org.bukkit.event.player.PlayerEvent
player
-
Constructor Summary
ConstructorDescriptionPlayerItemConsumeEvent
(@NotNull Player player, @NotNull ItemStack item) Deprecated.PlayerItemConsumeEvent
(@NotNull Player player, @NotNull ItemStack item, @NotNull EquipmentSlot hand) -
Method Summary
Modifier and TypeMethodDescriptiongetHand()
Get the hand used to consume the item.static @NotNull HandlerList
getItem()
Gets the item that is being consumed.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).boolean
Gets the cancellation state of this event.void
setCancelled
(boolean cancel) Sets the cancellation state of this event.void
Set the item being consumedvoid
setReplacement
(@Nullable ItemStack replacement) Set a custom item stack to replace the consumed item.Methods inherited from class org.bukkit.event.player.PlayerEvent
getPlayer
Methods inherited from class org.bukkit.event.Event
callEvent, getEventName, isAsynchronous
-
Constructor Details
-
PlayerItemConsumeEvent
public PlayerItemConsumeEvent(@NotNull @NotNull Player player, @NotNull @NotNull ItemStack item, @NotNull @NotNull EquipmentSlot hand) - Parameters:
player
- the player consumingitem
- the ItemStack being consumedhand
- the hand that was used
-
PlayerItemConsumeEvent
@Deprecated public PlayerItemConsumeEvent(@NotNull @NotNull Player player, @NotNull @NotNull ItemStack item) Deprecated.- Parameters:
player
- the player consumingitem
- the ItemStack being consumed
-
-
Method Details
-
getItem
Gets the item that is being consumed. Modifying the returned item will have no effect, you must usesetItem(org.bukkit.inventory.ItemStack)
instead.- Returns:
- an ItemStack for the item being consumed
-
setItem
Set the item being consumed- Parameters:
item
- the item being consumed
-
getHand
Get the hand used to consume the item.- Returns:
- the hand
-
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
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 interfaceCancellable
- 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 interfaceCancellable
- Parameters:
cancel
- true if you wish to cancel this event
-
getHandlers
- Specified by:
getHandlers
in classEvent
-
getHandlerList
-
PlayerItemConsumeEvent(Player, ItemStack, EquipmentSlot)