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

public class TameableDeathMessageEvent
extends EntityEvent
implements 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

Constructors

Constructor	Description
TameableDeathMessageEvent(@NotNull Tameable what, @NotNull Component deathMessage)

Method Summary

Modifier and Type	Method	Description
@NotNull Component	deathMessage()	Get 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.
@NotNull Tameable	getEntity()	Returns the Entity involved in this event
static @NotNull HandlerList	getHandlerList()
@NotNull HandlerList	getHandlers()
boolean	isCancelled()	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

Methods inherited from class java.lang.Object

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

Constructor Details

TameableDeathMessageEvent

public TameableDeathMessageEvent(@NotNull
 @NotNull Tameable what,
 @NotNull
 @NotNull Component deathMessage)

Method Details

deathMessage

public void deathMessage(@NotNull
 @NotNull Component deathMessage)

Set the death message that appears to the owner of the tameable.

Parameters:

deathMessage - Death message to appear

deathMessage

@NotNull
public @NotNull Component deathMessage()

Get the death message that appears to the owner of the tameable.

Returns:

Death message to appear

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

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

getEntity

@NotNull
public @NotNull Tameable getEntity()

Description copied from class: EntityEvent

Returns the Entity involved in this event

Overrides:

getEntity in class EntityEvent

Returns:

Entity who is involved in this event

getHandlers

@NotNull
public @NotNull HandlerList getHandlers()

Specified by:

getHandlers in class Event

getHandlerList

@NotNull
public static @NotNull HandlerList getHandlerList()