org.bukkit.event.block
Class BlockBreakEvent
java.lang.Object
org.bukkit.event.Event
org.bukkit.event.block.BlockEvent
org.bukkit.event.block.BlockExpEvent
org.bukkit.event.block.BlockBreakEvent
- All Implemented Interfaces:
- Cancellable
public class BlockBreakEvent
- extends BlockExpEvent
- implements Cancellable
Called when a block is broken by a player.
If you wish to have the block drop experience, you must set the experience value above 0.
By default, experience will be set in the event if:
The player is not in creative or adventure mode
The player can loot the block (ie: does not destroy it completely, by using the correct tool)
The player does not have silk touch
The block drops experience in vanilla MineCraft
Note:
Plugins wanting to simulate a traditional block drop should set the block to air and utilize their own methods for determining
what the default drop for the block being broken is and what to do about it, if anything.
If a Block Break event is cancelled, the block will not break and experience will not drop.
Method Summary |
Player |
getPlayer()
Gets the Player that is breaking the block involved in this event. |
boolean |
isCancelled()
Gets the cancellation state of this event. |
void |
setCancelled(boolean cancel)
Sets the cancellation state of this event. |
Methods inherited from class java.lang.Object |
clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait |
BlockBreakEvent
public BlockBreakEvent(Block theBlock,
Player player)
getPlayer
public Player getPlayer()
- Gets the Player that is breaking the block involved in this event.
- Returns:
- The Player that is breaking the block involved in this event
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
Copyright © 2013. All Rights Reserved.