twin/paper-mc
1
0
Fork 0
mirror of https://github.com/PaperMC/Paper.git synced 2025-07-31 20:22:05 -07:00
Code Issues Packages Projects Releases Wiki Activity

Expand PlayerDeathEvent API (#12221)

Browse Source
This commit is contained in:
Jakub Zacek
2025-05-07 02:14:58 +02:00
committed by GitHub
parent e2da5d2f0a
commit ab0253fecd
7 changed files with 127 additions and 35 deletions
Download Patch File Download Diff File Expand all files Collapse all files

70
paper-api/src/main/java/org/bukkit/event/entity/PlayerDeathEvent.java
View File

@@ -19,7 +19,9 @@ public class PlayerDeathEvent extends EntityDeathEvent {
private int newExp = 0;
private int newLevel = 0;
private int newTotalExp = 0;
private boolean showDeathMessages;
private Component deathMessage;
private Component deathScreenMessageOverride = null;
private boolean doExpDrop;
private boolean keepLevel = false;
private boolean keepInventory = false;
@@ -27,27 +29,28 @@ public class PlayerDeathEvent extends EntityDeathEvent {
private final List<ItemStack> itemsToKeep = new ArrayList<>();
@ApiStatus.Internal
public PlayerDeathEvent(final @NotNull Player player, final @NotNull DamageSource damageSource, final @NotNull List<ItemStack> drops, final int droppedExp, final @Nullable Component deathMessage) {
this(player, damageSource, drops, droppedExp, 0, deathMessage);
public PlayerDeathEvent(final @NotNull Player player, final @NotNull DamageSource damageSource, final @NotNull List<ItemStack> drops, final int droppedExp, final @Nullable Component deathMessage, final boolean showDeathMessages) {
this(player, damageSource, drops, droppedExp, 0, deathMessage, showDeathMessages);
}
@ApiStatus.Internal
public PlayerDeathEvent(final @NotNull Player player, final @NotNull DamageSource damageSource, final @NotNull List<ItemStack> drops, final int droppedExp, final int newExp, final @Nullable Component deathMessage) {
this(player, damageSource, drops, droppedExp, newExp, 0, 0, deathMessage);
public PlayerDeathEvent(final @NotNull Player player, final @NotNull DamageSource damageSource, final @NotNull List<ItemStack> drops, final int droppedExp, final int newExp, final @Nullable Component deathMessage, final boolean showDeathMessages) {
this(player, damageSource, drops, droppedExp, newExp, 0, 0, deathMessage, showDeathMessages);
}
@ApiStatus.Internal
public PlayerDeathEvent(final @NotNull Player player, final @NotNull DamageSource damageSource, final @NotNull List<ItemStack> drops, final int droppedExp, final int newExp, final int newTotalExp, final int newLevel, final @Nullable Component deathMessage) {
this(player, damageSource, drops, droppedExp, newExp, newTotalExp, newLevel, deathMessage, true);
public PlayerDeathEvent(final @NotNull Player player, final @NotNull DamageSource damageSource, final @NotNull List<ItemStack> drops, final int droppedExp, final int newExp, final int newTotalExp, final int newLevel, final @Nullable Component deathMessage, final boolean showDeathMessages) {
this(player, damageSource, drops, droppedExp, newExp, newTotalExp, newLevel, deathMessage, showDeathMessages, true);
}
@ApiStatus.Internal
public PlayerDeathEvent(final @NotNull Player player, final @NotNull DamageSource damageSource, final @NotNull List<ItemStack> drops, final int droppedExp, final int newExp, final int newTotalExp, final int newLevel, final @Nullable Component deathMessage, final boolean doExpDrop) {
public PlayerDeathEvent(final @NotNull Player player, final @NotNull DamageSource damageSource, final @NotNull List<ItemStack> drops, final int droppedExp, final int newExp, final int newTotalExp, final int newLevel, final @Nullable Component deathMessage, final boolean showDeathMessages, final boolean doExpDrop) {
super(player, damageSource, drops, droppedExp);
this.newExp = newExp;
this.newTotalExp = newTotalExp;
this.newLevel = newLevel;
this.deathMessage = deathMessage;
this.showDeathMessages = showDeathMessages;
this.doExpDrop = doExpDrop;
}
@@ -76,6 +79,7 @@ public class PlayerDeathEvent extends EntityDeathEvent {
this.newExp = newExp;
this.newTotalExp = newTotalExp;
this.newLevel = newLevel;
this.showDeathMessages = true;
this.deathMessage = LegacyComponentSerializer.legacySection().deserializeOrNull(deathMessage);
this.doExpDrop = doExpDrop;
}
@@ -86,6 +90,30 @@ public class PlayerDeathEvent extends EntityDeathEvent {
return (Player) this.entity;
}
/**
* Get whether the death message should be shown.
* By default, this is determined by {@link org.bukkit.GameRule#SHOW_DEATH_MESSAGES}.
*
* @return whether the death message should be shown
* @see #deathMessage()
* @see #deathScreenMessageOverride()
*/
public boolean getShowDeathMessages() {
return showDeathMessages;
}
/**
* Set whether the death message should be shown.
* By default, this is determined by {@link org.bukkit.GameRule#SHOW_DEATH_MESSAGES}.
*
* @param displayDeathMessage whether the death message should be shown
* @see #deathMessage()
* @see #deathScreenMessageOverride()
*/
public void setShowDeathMessages(boolean displayDeathMessage) {
this.showDeathMessages = displayDeathMessage;
}
/**
* Clarity method for getting the player. Not really needed except
* for reasons of clarity.
@@ -177,7 +205,7 @@ public class PlayerDeathEvent extends EntityDeathEvent {
/**
* Set the death message that will appear to everyone on the server.
*
* @param deathMessage Message to appear to other players on the server.
* @param deathMessage message to appear to other players on the server.
* @deprecated in favour of {@link #deathMessage(Component)}
*/
@Deprecated
@@ -197,6 +225,32 @@ public class PlayerDeathEvent extends EntityDeathEvent {
return LegacyComponentSerializer.legacySection().serializeOrNull(this.deathMessage);
}
/**
* Overrides the death message that will appear on the death screen of the dying player.
* By default, this is null.
* <p>
* If set to null, death screen message will be same as {@code deathMessage()}.
* <p>
* If the message exceeds 256 characters it will be truncated.
*
* @param deathScreenMessageOverride Message to appear on the death screen to the dying player.
*/
public void deathScreenMessageOverride(@Nullable Component deathScreenMessageOverride) {
this.deathScreenMessageOverride = deathScreenMessageOverride;
}
/**
* Get the death message override that will appear on the death screen of the dying player.
* By default, this is null.
* <p>
* If set to null, death screen message will be same as {@code deathMessage()}.
* <p>
* @return Message to appear on the death screen to the dying player.
*/
public @Nullable Component deathScreenMessageOverride() {
return this.deathScreenMessageOverride;
}
/**
* @return should experience be dropped from this death
*/