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.
Methods inherited from class java.lang.Object |
clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait |
PlayerItemConsumeEvent
public PlayerItemConsumeEvent(Player player,
ItemStack item)
- Parameters:
player
- the player consumingitem
- the ItemStack being consumed
getItem
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(ItemStack item)
- Set the item being consumed
- Parameters:
item
- the item being consumed
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
public HandlerList getHandlers()
- Specified by:
getHandlers
in class Event
getHandlerList
public static HandlerList getHandlerList()
Copyright © 2013. All Rights Reserved.