org.bukkit.event.block
Class BlockDamageEvent

java.lang.Object
  extended by org.bukkit.event.Event
      extended by org.bukkit.event.block.BlockEvent
          extended by org.bukkit.event.block.BlockDamageEvent
All Implemented Interfaces:
Cancellable

public class BlockDamageEvent
extends BlockEvent
implements Cancellable

Called when a block is damaged by a player.

If a Block Damage event is cancelled, the block will not be damaged.


Nested Class Summary
 
Nested classes/interfaces inherited from class org.bukkit.event.Event
Event.Result
 
Field Summary
 
Fields inherited from class org.bukkit.event.block.BlockEvent
block
 
Constructor Summary
BlockDamageEvent(Player player, Block block, ItemStack itemInHand, boolean instaBreak)
           
 
Method Summary
static HandlerList getHandlerList()
           
 HandlerList getHandlers()
           
 boolean getInstaBreak()
          Gets if the block is set to instantly break when damaged by the player.
 ItemStack getItemInHand()
          Gets the ItemStack for the item currently in the player's hand.
 Player getPlayer()
          Gets the player damaging 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.
 void setInstaBreak(boolean bool)
          Sets if the block should instantly break when damaged by the player.
 
Methods inherited from class org.bukkit.event.block.BlockEvent
getBlock
 
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 Detail

BlockDamageEvent

public BlockDamageEvent(Player player,
                        Block block,
                        ItemStack itemInHand,
                        boolean instaBreak)
Method Detail

getPlayer

public Player getPlayer()
Gets the player damaging the block involved in this event.

Returns:
The player damaging the block involved in this event

getInstaBreak

public boolean getInstaBreak()
Gets if the block is set to instantly break when damaged by the player.

Returns:
true if the block should instantly break when damaged by the player

setInstaBreak

public void setInstaBreak(boolean bool)
Sets if the block should instantly break when damaged by the player.

Parameters:
bool - true if you want the block to instantly break when damaged by the player

getItemInHand

public ItemStack getItemInHand()
Gets the ItemStack for the item currently in the player's hand.

Returns:
The ItemStack for the item currently in the player's 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

public HandlerList getHandlers()
Specified by:
getHandlers in class Event

getHandlerList

public static HandlerList getHandlerList()


Copyright © 2013. All Rights Reserved.