PaperMC/Spigot-API-Patches/0148-Improve-death-events.patch

178 lines
6 KiB
Diff
Raw Normal View History

From d41259020da1d0585cab3a286f3828a8be797415 Mon Sep 17 00:00:00 2001
From: Phoenix616 <mail@moep.tv>
Date: Tue, 21 Aug 2018 01:32:28 +0100
Subject: [PATCH] Improve death events
This adds the ability to cancel the death events and to modify the sound
an entity makes when dying. (In cases were no sound should it will be
called with shouldPlaySound set to false allowing unsilencing of silent
entities)
It makes handling of entity deaths a lot nicer as you no longer need
to listen on the damage event and calculate if the entity dies yourself
to cancel the death which has the benefit of also receiving the dropped
items and experience which is otherwise only properly possible by using
internal code.
diff --git a/src/main/java/org/bukkit/event/entity/EntityDeathEvent.java b/src/main/java/org/bukkit/event/entity/EntityDeathEvent.java
index ab9e81fd..fef134c6 100644
--- a/src/main/java/org/bukkit/event/entity/EntityDeathEvent.java
+++ b/src/main/java/org/bukkit/event/entity/EntityDeathEvent.java
@@ -8,10 +8,19 @@ import org.bukkit.inventory.ItemStack;
/**
* Thrown whenever a LivingEntity dies
*/
-public class EntityDeathEvent extends EntityEvent {
+public class EntityDeathEvent extends EntityEvent implements org.bukkit.event.Cancellable { // Paper - make cancellable
private static final HandlerList handlers = new HandlerList();
private final List<ItemStack> drops;
private int dropExp = 0;
+ // Paper start - make cancellable
+ private boolean cancelled;
+ private double reviveHealth = 0;
+ private boolean shouldPlayDeathSound;
+ private org.bukkit.Sound deathSound;
+ private org.bukkit.SoundCategory deathSoundCategory;
+ private float deathSoundVolume;
+ private float deathSoundPitch;
+ // Paper end
public EntityDeathEvent(final LivingEntity entity, final List<ItemStack> drops) {
this(entity, drops, 0);
@@ -69,4 +78,132 @@ public class EntityDeathEvent extends EntityEvent {
public static HandlerList getHandlerList() {
return handlers;
}
+
+ // Paper start - make cancellable
+ @Override
+ public boolean isCancelled() {
+ return cancelled;
+ }
+
+ @Override
+ public void setCancelled(boolean cancel) {
+ cancelled = cancel;
+ }
+
+ /**
+ * Get the amount of health that the entity should revive with after cancelling the event.
+ * Set to the entity's max health by default.
+ *
+ * @return The amount of health
+ */
+ public double getReviveHealth() {
+ return reviveHealth;
+ }
+
+ /**
+ * Set the amount of health that the entity should revive with after cancelling the event.
+ * Revive health value must be between 0 (exclusive) and the entity's max health (inclusive).
+ *
+ * @param reviveHealth The amount of health
+ * @throws IllegalArgumentException Thrown if the health is {@literal <= 0 or >} max health
+ */
+ public void setReviveHealth(double reviveHealth) throws IllegalArgumentException {
+ double maxHealth = ((LivingEntity) entity).getAttribute(org.bukkit.attribute.Attribute.GENERIC_MAX_HEALTH).getValue();
+ if ((maxHealth != 0 && reviveHealth <= 0) || (reviveHealth > maxHealth)) {
+ throw new IllegalArgumentException("Health must be between 0 (exclusive) and " + maxHealth + " (inclusive), but was " + reviveHealth);
+ }
+ this.reviveHealth = reviveHealth;
+ }
+
+
+ /**
+ * Whether or not the death sound should play when the entity dies. If the event is cancelled it does not play!
+ *
+ * @return Whether or not the death sound should play. Event is called with this set to false if the entity is silent.
+ */
+ public boolean shouldPlayDeathSound() {
+ return shouldPlayDeathSound;
+ }
+
+ /**
+ * Set whether or not the death sound should play when the entity dies. If the event is cancelled it does not play!
+ *
+ * @param playDeathSound Enable or disable the death sound
+ */
+ public void setShouldPlayDeathSound(boolean playDeathSound) {
+ this.shouldPlayDeathSound = playDeathSound;
+ }
+
+ /**
+ * Get the sound that the entity makes when dying
+ *
+ * @return The sound that the entity makes
+ */
+ public org.bukkit.Sound getDeathSound() {
+ return deathSound;
+ }
+
+ /**
+ * Set the sound that the entity makes when dying
+ *
+ * @param sound The sound that the entity should make when dying
+ */
+ public void setDeathSound(org.bukkit.Sound sound) {
+ deathSound = sound;
+ }
+
+ /**
+ * Get the sound category that the death sound should play in
+ *
+ * @return The sound category
+ */
+ public org.bukkit.SoundCategory getDeathSoundCategory() {
+ return deathSoundCategory;
+ }
+
+ /**
+ * Set the sound category that the death sound should play in.
+ *
+ * @param soundCategory The sound category
+ */
+ public void setDeathSoundCategory(org.bukkit.SoundCategory soundCategory) {
+ this.deathSoundCategory = soundCategory;
+ }
+
+ /**
+ * Get the volume that the death sound will play at.
+ *
+ * @return The volume the death sound will play at
+ */
+ public float getDeathSoundVolume() {
+ return deathSoundVolume;
+ }
+
+ /**
+ * Set the volume the death sound should play at. If the event is cancelled this will not play the sound!
+ *
+ * @param volume The volume the death sound should play at
+ */
+ public void setDeathSoundVolume(float volume) {
+ this.deathSoundVolume = volume;
+ }
+
+ /**
+ * Get the pitch that the death sound will play with.
+ *
+ * @return The pitch the death sound will play with
+ */
+ public float getDeathSoundPitch() {
+ return deathSoundPitch;
+ }
+
+ /**
+ * GSetet the pitch that the death sound should play with.
+ *
+ * @param pitch The pitch the death sound should play with
+ */
+ public void setDeathSoundPitch(float pitch) {
+ this.deathSoundPitch = pitch;
+ }
+ // Paper end
}
--
Updated Upstream (Bukkit/CraftBukkit/Spigot) Upstream has released updates that appears to apply and compile correctly. This update has not been tested by PaperMC and as with ANY update, please do your own testing Warning: this commit contains more mapping changes from upstream, As always, ensure that you have working backups and test this build before deployment; Developers working on paper will, yet again, need to delete their work/Minecraft/1.13.2 folder Bukkit Changes: 7fca5fd4 SPIGOT-4558: Preserve user order in the face of copied defaults in configurations 15c9b1eb Ignore spurious slot IDs sent by client, e.g. in enchanting tables 5d2a10c5 SPIGOT-3747: Add API for force loaded chunks d6dd2bb3 SPIGOT-3538: Add getHitBlockFace for ProjectileHitEvent 771db4aa SPIGOT-794: Call EntityPlaceEvent for Minecart placement 55462509 Add InventoryView#getSlotType 2f3ce5b6 Remove EntityTransformEvent and CustomItemTagContainer from draft API f04ad7b6 Make ProjectileLaunchEvent extend EntitySpawnEvent ccb85808 Define EntitySpawnEvent b8cc3ebe Add PlayerItemDamageEvent 184a495d Ease ClassLoader Deadlocks Where Possible 11ac4728 Expand Boolean Prompt Values in Conversation API aae62d51 Added getAllSessionData() to the Conversation API. 9290ff91 Add InventoryView#getInventory API 995e530f Add API to get / set base arrow damage CraftBukkit Changes: c4a67eed SPIGOT-4556: Fix plugins closing inventory during drop events 5be2ddcb Replace version constants with methods to prevent compiler inlining a5b9c7b3 Use API method to create offset command completions 2bc7d1df SPIGOT-3747: Add API for force loaded chunks a408f375 SPIGOT-3538: Add getHitBlockFace for ProjectileHitEvent b54b9409 SPIGOT-2864: Make Arrow / Item setTicksLived behave like FallingBlock 79ded7a8 SPIGOT-1811: Death message not shown on respawn screen b4a4f15d SPIGOT-943: InventoryCloseEvent called on death regardless of open inventory 0afed592 SPIGOT-794: Call EntityPlaceEvent for Minecart placement 2b2d084a Add InventoryView#getSlotType 01a9959a Do not use deprecated ItemSpawnEvent constructor 9642498d SPIGOT-4547: Call EntitySpawnEvent as general spawn fallback event 963f4a5f Add PlayerItemDamageEvent 63db0445 Add API to get / set base arrow damage 531c25d7 Add CraftMagicNumbers.MAPPINGS_VERSION for use by NMS plugins d05c8b14 Mappings Update bd36e200 SPIGOT-4551: Ignore invalid attribute modifier slots Spigot Changes: 518206a1 Remove redundant trove depend 1959ad21 MC-11211,SPIGOT-4552: Fix placing double slabs at y = 255 29ab5e43 SPIGOT-3661: Allow arguments in restart-script 7cc46316 SPIGOT-852: Growth modifiers for beetroots, potatoes, carrots 82e117e1 Squelch "fatal: Resolve operation not in progress" message 0a1a68e7 Mappings Update & Patch Rebuild
2019-01-01 04:15:55 +01:00
2.20.1