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

public abstract class PlayerBucketEvent
extends PlayerEvent
implements Cancellable

Called when a player interacts with a Bucket

Since:

1.0.0

Nested Class Summary

Nested classes/interfaces inherited from class Event

Event.Result

Field Summary

Fields inherited from class PlayerEvent

player

Constructor Summary

Constructors

Constructor	Description
PlayerBucketEvent(@NotNull Player player, @NotNull Block blockClicked, @NotNull BlockFace blockFace, @NotNull Material bucket, @NotNull ItemStack itemInHand)	Deprecated, for removal: This API element is subject to removal in a future version.
PlayerBucketEvent(@NotNull Player player, @NotNull Block block, @NotNull Block blockClicked, @NotNull BlockFace blockFace, @NotNull Material bucket, @NotNull ItemStack itemInHand)	Deprecated, for removal: This API element is subject to removal in a future version.
PlayerBucketEvent(@NotNull Player player, @NotNull Block block, @NotNull Block blockClicked, @NotNull BlockFace blockFace, @NotNull Material bucket, @NotNull ItemStack itemInHand, @NotNull EquipmentSlot hand)

Method Summary

Modifier and Type	Method	Description
final @NotNull Block	getBlock()	Gets the block involved in this event.
@NotNull Block	getBlockClicked()	Return the block clicked
@NotNull BlockFace	getBlockFace()	Get the face on the clicked block
@NotNull Material	getBucket()	Returns the bucket used in this event
@NotNull EquipmentSlot	getHand()	Get the hand that was used in this event.
@Nullable 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(@Nullable ItemStack itemStack)	Set the item in hand after the event

Methods inherited from class PlayerEvent

getPlayer

Methods inherited from class Event

callEvent, getEventName, getHandlers, isAsynchronous

Methods inherited from class Object

clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

Constructor Details

PlayerBucketEvent

@Internal
@Deprecated(since="1.14.4",
            forRemoval=true)
public PlayerBucketEvent(@NotNull
 @NotNull Player player,
 @NotNull
 @NotNull Block blockClicked,
 @NotNull
 @NotNull BlockFace blockFace,
 @NotNull
 @NotNull Material bucket,
 @NotNull
 @NotNull ItemStack itemInHand)

Deprecated, for removal: This API element is subject to removal in a future version.

PlayerBucketEvent

@Internal
@Deprecated(since="1.19.2",
            forRemoval=true)
public PlayerBucketEvent(@NotNull
 @NotNull Player player,
 @NotNull
 @NotNull Block block,
 @NotNull
 @NotNull Block blockClicked,
 @NotNull
 @NotNull BlockFace blockFace,
 @NotNull
 @NotNull Material bucket,
 @NotNull
 @NotNull ItemStack itemInHand)

Deprecated, for removal: This API element is subject to removal in a future version.

PlayerBucketEvent

@Internal
public PlayerBucketEvent(@NotNull
 @NotNull Player player,
 @NotNull
 @NotNull Block block,
 @NotNull
 @NotNull Block blockClicked,
 @NotNull
 @NotNull BlockFace blockFace,
 @NotNull
 @NotNull Material bucket,
 @NotNull
 @NotNull ItemStack itemInHand,
 @NotNull
 @NotNull EquipmentSlot hand)

Method Details

getBlock

@NotNull
public final @NotNull Block getBlock()

Gets the block involved in this event.

Returns:

The Block which block is involved in this event

Since:

1.14.4

getBlockClicked

@NotNull
public @NotNull Block getBlockClicked()

Return the block clicked

Returns:

the clicked block

Since:

1.0.0

getBlockFace

@NotNull
public @NotNull BlockFace getBlockFace()

Get the face on the clicked block

Returns:

the clicked face

Since:

1.0.0

getBucket

@NotNull
public @NotNull Material getBucket()

Returns the bucket used in this event

Returns:

the used bucket

Since:

1.0.0

getHand

@NotNull
public @NotNull EquipmentSlot getHand()

Get the hand that was used in this event.

Returns:

the hand

Since:

1.13

getItemStack

@Nullable
public @Nullable ItemStack getItemStack()

Get the resulting item in hand after the bucket event

Returns:

ItemStack hold in hand after the event.

Since:

1.0.0

setItemStack

public void setItemStack(@Nullable
 @Nullable ItemStack itemStack)

Set the item in hand after the event

Parameters:

itemStack - the new held ItemStack after the bucket event.

Since:

1.0.0

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

Since:

1.0.0

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

Since:

1.0.0