Package org.bukkit.event.player
Class PlayerBucketEvent
java.lang.Object
org.bukkit.event.Event
org.bukkit.event.player.PlayerEvent
org.bukkit.event.player.PlayerBucketEvent
- All Implemented Interfaces:
Cancellable
- Direct Known Subclasses:
PlayerBucketEmptyEvent
,PlayerBucketFillEvent
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
ConstructorDescriptionPlayerBucketEvent
(@NotNull Player who, @NotNull Block blockClicked, @NotNull BlockFace blockFace, @NotNull Material bucket, @NotNull ItemStack itemInHand) Deprecated.PlayerBucketEvent
(@NotNull Player who, @NotNull Block block, @NotNull Block blockClicked, @NotNull BlockFace blockFace, @NotNull Material bucket, @NotNull ItemStack itemInHand) Deprecated.PlayerBucketEvent
(@NotNull Player who, @NotNull Block block, @NotNull Block blockClicked, @NotNull BlockFace blockFace, @NotNull Material bucket, @NotNull ItemStack itemInHand, @NotNull EquipmentSlot hand) -
Method Summary
Modifier and TypeMethodDescriptiongetBlock()
Gets the block involved in this event.Return the block clickedGet the face on the clicked blockReturns the bucket used in this eventgetHand()
Get the hand that was used in this event.Get the resulting item in hand after the bucket eventboolean
Gets the cancellation state of this event.void
setCancelled
(boolean cancel) Sets the cancellation state of this event.void
setItemStack
(@Nullable ItemStack itemStack) Set the item in hand after the eventMethods inherited from class org.bukkit.event.player.PlayerEvent
getPlayer
Methods inherited from class org.bukkit.event.Event
callEvent, getEventName, getHandlers, isAsynchronous
-
Constructor Details
-
PlayerBucketEvent
@Deprecated public PlayerBucketEvent(@NotNull @NotNull Player who, @NotNull @NotNull Block blockClicked, @NotNull @NotNull BlockFace blockFace, @NotNull @NotNull Material bucket, @NotNull @NotNull ItemStack itemInHand) Deprecated. -
PlayerBucketEvent
@Deprecated public PlayerBucketEvent(@NotNull @NotNull Player who, @NotNull @NotNull Block block, @NotNull @NotNull Block blockClicked, @NotNull @NotNull BlockFace blockFace, @NotNull @NotNull Material bucket, @NotNull @NotNull ItemStack itemInHand) Deprecated. -
PlayerBucketEvent
-
-
Method Details
-
getBucket
Returns the bucket used in this event- Returns:
- the used bucket
-
getItemStack
Get the resulting item in hand after the bucket event- Returns:
- ItemStack hold in hand after the event.
-
setItemStack
Set the item in hand after the event- Parameters:
itemStack
- the new held ItemStack after the bucket event.
-
getBlock
Gets the block involved in this event.- Returns:
- The Block which block is involved in this event
-
getBlockClicked
Return the block clicked- Returns:
- the clicked block
-
getBlockFace
Get the face on the clicked block- Returns:
- the clicked face
-
getHand
Get the hand that was used in this event.- Returns:
- the 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 interfaceCancellable
- 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 interfaceCancellable
- Parameters:
cancel
- true if you wish to cancel this event
-