Package net.minestom.server.event.player

Class PlayerDeathEvent

java.lang.Object

net.minestom.server.event.player.PlayerDeathEvent

All Implemented Interfaces:

Event, EntityEvent, EntityInstanceEvent, InstanceEvent, PlayerEvent, PlayerInstanceEvent

public class PlayerDeathEvent
extends Object
implements PlayerInstanceEvent

Called when a player die in Player.kill().

Constructor Summary

Constructors

Constructor	Description
PlayerDeathEvent(@NotNull Player player, Component deathText, Component chatMessage)

Method Summary

Modifier and Type	Method	Description
@Nullable Component	getChatMessage()	Gets the message sent to chat.
@Nullable Component	getDeathText()	Gets the text displayed in the death screen.
@NotNull Player	getPlayer()	Gets the player.
void	setChatMessage(@Nullable Component chatMessage)	Changes the text sent in chat
void	setDeathText(@Nullable Component deathText)	Changes the text displayed in the death screen.

Methods inherited from class java.lang.Object

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

Methods inherited from interface net.minestom.server.event.trait.EntityInstanceEvent

getInstance

Methods inherited from interface net.minestom.server.event.trait.PlayerEvent

getEntity

Constructor Details

PlayerDeathEvent

public PlayerDeathEvent(@NotNull
 @NotNull Player player,
 Component deathText,
 Component chatMessage)

Method Details

getDeathText

@Nullable
public @Nullable Component getDeathText()

Gets the text displayed in the death screen.

Returns:

the death text, can be null

setDeathText

public void setDeathText(@Nullable
 @Nullable Component deathText)

Changes the text displayed in the death screen.

Parameters:

deathText - the death text to display, null to remove

getChatMessage

@Nullable
public @Nullable Component getChatMessage()

Gets the message sent to chat.

Returns:

the death chat message

setChatMessage

public void setChatMessage(@Nullable
 @Nullable Component chatMessage)

Changes the text sent in chat

Parameters:

chatMessage - the death message to send, null to remove

getPlayer

@NotNull
public @NotNull Player getPlayer()

Description copied from interface: PlayerEvent

Gets the player.

Specified by:

getPlayer in interface PlayerEvent

Returns:

the player