Package org.bukkit.event.player
Class PlayerUnleashEntityEvent
java.lang.Object
org.bukkit.event.Event
org.bukkit.event.entity.EntityEvent
org.bukkit.event.entity.EntityUnleashEvent
org.bukkit.event.player.PlayerUnleashEntityEvent
- All Implemented Interfaces:
Cancellable
Called prior to an entity being unleashed due to a player's action.
-
Nested Class Summary
Nested classes/interfaces inherited from class org.bukkit.event.entity.EntityUnleashEvent
EntityUnleashEvent.UnleashReasonNested classes/interfaces inherited from class org.bukkit.event.Event
Event.Result -
Field Summary
Fields inherited from class org.bukkit.event.entity.EntityEvent
entity -
Constructor Summary
ConstructorsConstructorDescriptionPlayerUnleashEntityEvent(@NotNull Entity entity, @NotNull Player player) Deprecated.PlayerUnleashEntityEvent(@NotNull Entity entity, @NotNull Player player, @NotNull EquipmentSlot hand) Deprecated.PlayerUnleashEntityEvent(@NotNull Entity entity, @NotNull Player player, @NotNull EquipmentSlot hand, boolean dropLeash) -
Method Summary
Modifier and TypeMethodDescriptiongetHand()Get the hand used by the player to unleash the entity.Returns the player who is unleashing the entity.booleanGets the cancellation state of this event.voidsetCancelled(boolean cancel) Sets the cancellation state of this event.Methods inherited from class org.bukkit.event.entity.EntityUnleashEvent
getHandlerList, getHandlers, getReason, isDropLeash, setDropLeashMethods inherited from class org.bukkit.event.entity.EntityEvent
getEntity, getEntityTypeMethods inherited from class org.bukkit.event.Event
callEvent, getEventName, isAsynchronous
-
Constructor Details
-
PlayerUnleashEntityEvent
@Deprecated public PlayerUnleashEntityEvent(@NotNull @NotNull Entity entity, @NotNull @NotNull Player player, @NotNull @NotNull EquipmentSlot hand) Deprecated. -
PlayerUnleashEntityEvent
-
PlayerUnleashEntityEvent
@Deprecated public PlayerUnleashEntityEvent(@NotNull @NotNull Entity entity, @NotNull @NotNull Player player) Deprecated.
-
-
Method Details
-
getPlayer
Returns the player who is unleashing the entity.- Returns:
- The player
-
getHand
Get the hand used by the player to unleash the entity.- Returns:
- the hand
-
isCancelled
public boolean isCancelled()Description copied from interface:CancellableGets 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:
isCancelledin interfaceCancellable- Overrides:
isCancelledin classEntityUnleashEvent- Returns:
- true if this event is cancelled
-
setCancelled
public void setCancelled(boolean cancel) Description copied from interface:CancellableSets 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:
setCancelledin interfaceCancellable- Overrides:
setCancelledin classEntityUnleashEvent- Parameters:
cancel- true if you wish to cancel this event
-