Bukkit-API  1.7.9-R0.2
The inofficial Bukkit-API
org.bukkit.event.player.PlayerBucketEvent Class Referenceabstract
Inheritance diagram for org.bukkit.event.player.PlayerBucketEvent:
org.bukkit.event.player.PlayerEvent org.bukkit.event.Cancellable org.bukkit.event.Event org.bukkit.event.player.PlayerBucketEmptyEvent org.bukkit.event.player.PlayerBucketFillEvent

Public Member Functions

 PlayerBucketEvent (final Player who, final Block blockClicked, final BlockFace blockFace, final Material bucket, final ItemStack itemInHand)
 
Material getBucket ()
 
ItemStack getItemStack ()
 
void setItemStack (ItemStack itemStack)
 
Block getBlockClicked ()
 
BlockFace getBlockFace ()
 
boolean isCancelled ()
 
void setCancelled (boolean cancel)
 
- Public Member Functions inherited from org.bukkit.event.player.PlayerEvent
 PlayerEvent (final Player who)
 
final Player getPlayer ()
 
- Public Member Functions inherited from org.bukkit.event.Event
 Event ()
 
 Event (boolean isAsync)
 
String getEventName ()
 
abstract HandlerList getHandlers ()
 
final boolean isAsynchronous ()
 

Additional Inherited Members

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

Detailed Description

Called when a player interacts with a Bucket

Definition at line 13 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 60 of file PlayerBucketEvent.java.

60  {
61  return blockClicked;
62  }
BlockFace org.bukkit.event.player.PlayerBucketEvent.getBlockFace ( )

Get the face on the clicked block

Returns
the clicked face

Definition at line 69 of file PlayerBucketEvent.java.

69  {
70  return blockFace;
71  }
Material org.bukkit.event.player.PlayerBucketEvent.getBucket ( )

Returns the bucket used in this event

Returns
the used bucket

Definition at line 33 of file PlayerBucketEvent.java.

33  {
34  return bucket;
35  }
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 42 of file PlayerBucketEvent.java.

42  {
43  return itemStack;
44  }
boolean org.bukkit.event.player.PlayerBucketEvent.isCancelled ( )

Gets the cancellation state of this event. A cancelled event will not be executed in the server, but will still pass to other plugins

Returns
true if this event is cancelled

Implements org.bukkit.event.Cancellable.

Definition at line 73 of file PlayerBucketEvent.java.

73  {
74  return cancelled;
75  }
void org.bukkit.event.player.PlayerBucketEvent.setCancelled ( boolean  cancel)

Sets the cancellation state of this event. A cancelled event will not be executed in the server, but will still pass to other plugins.

Parameters
canceltrue if you wish to cancel this event

Implements org.bukkit.event.Cancellable.

Definition at line 77 of file PlayerBucketEvent.java.

77  {
78  this.cancelled = cancel;
79  }
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 51 of file PlayerBucketEvent.java.

51  {
52  this.itemStack = itemStack;
53  }

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