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.

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

Constructors

Constructor	Description
PlayerItemConsumeEvent(Player player, ItemStack item)	Deprecated. use PlayerItemConsumeEvent(Player, ItemStack, EquipmentSlot)
PlayerItemConsumeEvent(Player player, ItemStack item, EquipmentSlot hand)

Method Summary

Modifier and Type	Method	Description
EquipmentSlot	getHand()	Get the hand used to consume the item.
static HandlerList	getHandlerList()
HandlerList	getHandlers()
ItemStack	getItem()	Gets the item that is being consumed.
boolean	isCancelled()	Gets the cancellation state of this event.
void	setCancelled(boolean cancel)	Sets the cancellation state of this event.
void	setItem(ItemStack item)	Set the item being consumed

Methods inherited from class org.bukkit.event.player.PlayerEvent

getPlayer

Methods inherited from class org.bukkit.event.Event

getEventName, isAsynchronous

Methods inherited from class java.lang.Object

clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

Constructor Details

PlayerItemConsumeEvent

public PlayerItemConsumeEvent(@NotNull
 Player player,
 @NotNull
 ItemStack item,
 @NotNull
 EquipmentSlot hand)

Parameters:

player - the player consuming

item - the ItemStack being consumed

hand - the hand that was used

PlayerItemConsumeEvent

@Deprecated
public PlayerItemConsumeEvent(@NotNull
 Player player,
 @NotNull
 ItemStack item)

Deprecated.

use PlayerItemConsumeEvent(Player, ItemStack, EquipmentSlot)

Parameters:

player - the player consuming

item - the ItemStack being consumed

Method Details

getItem

@NotNull
public 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
 ItemStack item)

Set the item being consumed

Parameters:

item - the item being consumed

getHand

@NotNull
public EquipmentSlot getHand()

Get the hand used to consume the item.

Returns:

the hand

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 HandlerList getHandlers()

Specified by:

getHandlers in class Event

getHandlerList

@NotNull
public static HandlerList getHandlerList()