Package io.papermc.paper.event.entity
Class TameableDeathMessageEvent
java.lang.Object
org.bukkit.event.Event
org.bukkit.event.entity.EntityEvent
io.papermc.paper.event.entity.TameableDeathMessageEvent
- All Implemented Interfaces:
Cancellable
Called when a
Tameable
dies and sends a death message.-
Nested Class Summary
Nested 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
ConstructorDescriptionTameableDeathMessageEvent
(@NotNull Tameable tameable, @NotNull Component deathMessage) -
Method Summary
Modifier and TypeMethodDescriptionGet the death message that appears to the owner of the tameable.void
deathMessage
(@NotNull Component deathMessage) Set the death message that appears to the owner of the tameable.Returns the Entity involved in this eventstatic @NotNull HandlerList
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.entity.EntityEvent
getEntityType
Methods inherited from class org.bukkit.event.Event
callEvent, getEventName, isAsynchronous
-
Constructor Details
-
TameableDeathMessageEvent
-
-
Method Details
-
deathMessage
Set the death message that appears to the owner of the tameable.- Parameters:
deathMessage
- Death message to appear
-
deathMessage
Get the death message that appears to the owner of the tameable.- Returns:
- Death message to appear
-
getEntity
Description copied from class:EntityEvent
Returns the Entity involved in this event- Overrides:
getEntity
in classEntityEvent
- Returns:
- Entity who is involved in this event
-
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
-