org.bukkit.event.player
Class PlayerBucketEvent

java.lang.Object
  extended by org.bukkit.event.Event
      extended by org.bukkit.event.player.PlayerEvent
          extended by org.bukkit.event.player.PlayerBucketEvent
All Implemented Interfaces:
Cancellable
Direct Known Subclasses:
PlayerBucketEmptyEvent, PlayerBucketFillEvent

public abstract class PlayerBucketEvent
extends PlayerEvent
implements Cancellable

Called when a player interacts with a Bucket


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
PlayerBucketEvent(Player who, Block blockClicked, BlockFace blockFace, Material bucket, ItemStack itemInHand)
           
 
Method Summary
 Block getBlockClicked()
          Return the block clicked
 BlockFace getBlockFace()
          Get the face on the clicked block
 Material getBucket()
          Returns the bucket used in this event
 ItemStack getItemStack()
          Get the resulting item in hand after the bucket event
 boolean isCancelled()
          Gets the cancellation state of this event.
 void setCancelled(boolean cancel)
          Sets the cancellation state of this event.
 void setItemStack(ItemStack itemStack)
          Set the item in hand after the event
 
Methods inherited from class org.bukkit.event.player.PlayerEvent
getPlayer
 
Methods inherited from class org.bukkit.event.Event
getEventName, getHandlers, isAsynchronous
 
Methods inherited from class java.lang.Object
clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait
 

Constructor Detail

PlayerBucketEvent

public PlayerBucketEvent(Player who,
                         Block blockClicked,
                         BlockFace blockFace,
                         Material bucket,
                         ItemStack itemInHand)
Method Detail

getBucket

public Material getBucket()
Returns the bucket used in this event

Returns:
the used bucket

getItemStack

public ItemStack getItemStack()
Get the resulting item in hand after the bucket event

Returns:
Itemstack hold in hand after the event.

setItemStack

public void setItemStack(ItemStack itemStack)
Set the item in hand after the event

Parameters:
itemStack - the new held itemstack after the bucket event.

getBlockClicked

public Block getBlockClicked()
Return the block clicked

Returns:
the blicked block

getBlockFace

public BlockFace getBlockFace()
Get the face on the clicked block

Returns:
the clicked face

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.