Package org.bukkit.event.player
Class PlayerHarvestBlockEvent
java.lang.Object
org.bukkit.event.Event
org.bukkit.event.player.PlayerEvent
org.bukkit.event.player.PlayerHarvestBlockEvent
- All Implemented Interfaces:
Cancellable
public class PlayerHarvestBlockEvent extends PlayerEvent implements Cancellable
This event is called whenever a player harvests a block.
A 'harvest' is when a block drops an item (usually some sort of crop) and changes state, but is not broken in order to drop the item.
This event is not called for when a block is broken, to handle that, listen for
A 'harvest' is when a block drops an item (usually some sort of crop) and changes state, but is not broken in order to drop the item.
This event is not called for when a block is broken, to handle that, listen for
BlockBreakEvent
and
BlockDropItemEvent
.-
Nested Class Summary
-
Field Summary
-
Constructor Summary
Constructors Constructor Description PlayerHarvestBlockEvent(Player player, Block harvestedBlock, List<ItemStack> itemsHarvested)
-
Method Summary
Modifier and Type Method Description static HandlerList
getHandlerList()
HandlerList
getHandlers()
Block
getHarvestedBlock()
Gets the block that is being harvested.List<ItemStack>
getItemsHarvested()
Gets a list of items that are being harvested from this block.boolean
isCancelled()
Gets the cancellation state of this event.void
setCancelled(boolean cancel)
Sets the cancellation state of this event.
-
Constructor Details
-
Method Details
-
getHarvestedBlock
Gets the block that is being harvested.- Returns:
- The block that is being harvested
-
getItemsHarvested
Gets a list of items that are being harvested from this block.- Returns:
- A list of items that are being harvested from this block
-
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
-