Bukkit  1.4.7-R1.0
 All Classes Namespaces Files Functions Variables Enumerator Pages
org.bukkit.event.player.PlayerBucketEvent Class Reference
+ Inheritance diagram for org.bukkit.event.player.PlayerBucketEvent:
+ Collaboration diagram for org.bukkit.event.player.PlayerBucketEvent:

Public Member Functions

 PlayerBucketEvent (final Player who, final Block blockClicked, final BlockFace blockFace, final Material bucket, final ItemStack itemInHand)
 
Material getBucket ()
 Returns the bucket used in this event.
 
ItemStack getItemStack ()
 Get the resulting item in hand after the bucket event.
 
void setItemStack (ItemStack itemStack)
 Set the item in hand after the event.
 
Block getBlockClicked ()
 Return the block clicked.
 
BlockFace getBlockFace ()
 Get the face on the clicked block.
 
boolean isCancelled ()
 
void setCancelled (boolean cancel)
 
- Public Member Functions inherited from org.bukkit.event.player.PlayerEvent
 PlayerEvent (final Player who)
 
final Player getPlayer ()
 Returns the player involved in this event.
 
- Public Member Functions inherited from org.bukkit.event.Event
 Event ()
 The default constructor is defined for cleaner code.
 
 Event (boolean isAsync)
 This constructor is used to explicitly declare an event as synchronous or asynchronous.
 
String getEventName ()
 
abstract HandlerList getHandlers ()
 
final boolean isAsynchronous ()
 Any custom event that should not by synchronized with other events must use the specific constructor.
 
- Public Member Functions inherited from org.bukkit.event.Cancellable
boolean isCancelled ()
 Gets the cancellation state of this event.
 
void setCancelled (boolean cancel)
 Sets the cancellation state of this event.
 

Additional Inherited Members

- Protected Attributes inherited from org.bukkit.event.player.PlayerEvent
Player player
 

Detailed Description

Definition at line 10 of file PlayerBucketEvent.java.

Constructor & Destructor Documentation

org.bukkit.event.player.PlayerBucketEvent.PlayerBucketEvent ( final Player  who,
final Block  blockClicked,
final BlockFace  blockFace,
final Material  bucket,
final ItemStack  itemInHand 
)

Definition at line 17 of file PlayerBucketEvent.java.

Member Function Documentation

Block org.bukkit.event.player.PlayerBucketEvent.getBlockClicked ( )

Return the block clicked.

Returns
the blicked block

Definition at line 57 of file PlayerBucketEvent.java.

BlockFace org.bukkit.event.player.PlayerBucketEvent.getBlockFace ( )

Get the face on the clicked block.

Returns
the clicked face

Definition at line 66 of file PlayerBucketEvent.java.

Material org.bukkit.event.player.PlayerBucketEvent.getBucket ( )

Returns the bucket used in this event.

Returns
the used bucket

Definition at line 30 of file PlayerBucketEvent.java.

ItemStack org.bukkit.event.player.PlayerBucketEvent.getItemStack ( )

Get the resulting item in hand after the bucket event.

Returns
Itemstack hold in hand after the event.

Definition at line 39 of file PlayerBucketEvent.java.

boolean org.bukkit.event.player.PlayerBucketEvent.isCancelled ( )

Definition at line 70 of file PlayerBucketEvent.java.

void org.bukkit.event.player.PlayerBucketEvent.setCancelled ( boolean  cancel)

Definition at line 74 of file PlayerBucketEvent.java.

void org.bukkit.event.player.PlayerBucketEvent.setItemStack ( ItemStack  itemStack)

Set the item in hand after the event.

Parameters
itemStackthe new held itemstack after the bucket event.

Definition at line 48 of file PlayerBucketEvent.java.


The documentation for this class was generated from the following file: