Package org.bukkit.event.player
Class PlayerBucketEntityEvent
java.lang.Object
org.bukkit.event.Event
org.bukkit.event.player.PlayerEvent
org.bukkit.event.player.PlayerBucketEntityEvent
- All Implemented Interfaces:
Cancellable
- Direct Known Subclasses:
PlayerBucketFishEvent
This event is called whenever a player captures an entity in 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
-
Method Summary
Modifier and TypeMethodDescriptionGets theEntity
being put into the bucket.Gets the bucket that theEntity
will be put into.getHand()
Get the hand that was used to bucket the entity.static @NotNull HandlerList
Gets the bucket used to capture theEntity
.boolean
Gets the cancellation state of this event.void
setCancelled
(boolean cancel) Sets the cancellation state of this event.Methods inherited from class org.bukkit.event.player.PlayerEvent
getPlayer
Methods inherited from class org.bukkit.event.Event
callEvent, getEventName, isAsynchronous
-
Constructor Details
-
PlayerBucketEntityEvent
-
-
Method Details
-
getEntity
Gets theEntity
being put into the bucket.- Returns:
- The
Entity
being put into the bucket
-
getOriginalBucket
Gets the bucket used to capture theEntity
. This refers to the bucket clicked with, egMaterial.WATER_BUCKET
.- Returns:
- The used bucket
-
getEntityBucket
Gets the bucket that theEntity
will be put into. This refers to the bucket with the entity, egMaterial.PUFFERFISH_BUCKET
.- Returns:
- The bucket that the
Entity
will be put into
-
getHand
Get the hand that was used to bucket the entity.- 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
-
getHandlers
- Specified by:
getHandlers
in classEvent
-
getHandlerList
-