Paper/patches/api/0385-ItemStack-damage-API.patch
Jake Potrebic 3e90a19183
Updated Upstream (Bukkit/CraftBukkit)
Upstream has released updates that appear to apply and compile correctly.
This update has not been tested by PaperMC and as with ANY update, please do your own testing

Bukkit Changes:
304e83eb PR-1002: Improve documentation and implementation of getMaxStackSize
e8215ea2 SPIGOT-7638: Library loader does not seem to resolve every dependency
79c595c0 SPIGOT-7637: Bad logic in checking nullability of AttributeModifier slots

CraftBukkit Changes:
91b1fc3f1 SPIGOT-7644: Fix ItemMeta#getAsString
4e77a81e1 SPIGOT-7615: PlayerLeashEntityEvent cancelled eats lead
996f660f3 Do not remove leash knot if leasing to an existing leash knot gets cancelled
f70367d42 SPIGOT-7643: Fix inverted leash event cancelled usage and remove leash knot if no entity gets leashed
7ddb48294 SPIGOT-7640: Abnormal jumping height of wind charge
080c8711e SPIGOT-7639: Incoming plugin channels not working
ad549847e Open a direct connection instead of pinging mojang server to check if it is reachable
38e2926c5 SPIGOT-7365: DamageCause blocked by shield should trigger invulnerableTime
2024-04-27 18:00:01 -07:00

92 lines
4.0 KiB
Diff

From 0000000000000000000000000000000000000000 Mon Sep 17 00:00:00 2001
From: Jake Potrebic <jake.m.potrebic@gmail.com>
Date: Sun, 8 May 2022 13:35:58 -0700
Subject: [PATCH] ItemStack damage API
Adds methods notify clients about item breaks and
to simulate damage done to an itemstack and all
the logic associated with damaging them
diff --git a/src/main/java/org/bukkit/entity/LivingEntity.java b/src/main/java/org/bukkit/entity/LivingEntity.java
index 6bfc8a2148f504370df938447f4f6b757f1a516b..208bab1f5a3200f54141c38ee4272629cfc66da5 100644
--- a/src/main/java/org/bukkit/entity/LivingEntity.java
+++ b/src/main/java/org/bukkit/entity/LivingEntity.java
@@ -1365,4 +1365,53 @@ public interface LivingEntity extends Attributable, Damageable, ProjectileSource
*/
void knockback(double strength, double directionX, double directionZ);
// Paper end - knockback API
+
+ // Paper start - ItemStack damage API
+ /**
+ * Notifies all clients tracking this entity that the item in
+ * the slot of this entity broke.
+ * <p>
+ * NOTE: this does not mutate any entity state
+ *
+ * @param slot the slot
+ */
+ void broadcastSlotBreak(org.bukkit.inventory.@NotNull EquipmentSlot slot);
+
+ /**
+ * Notifies specified players that the item in the slot
+ * of this entity broke.
+ * <p>
+ * NOTE: this does not mutate any entity state
+ *
+ * @param slot the slot
+ * @param players the players to notify
+ */
+ void broadcastSlotBreak(org.bukkit.inventory.@NotNull EquipmentSlot slot, @NotNull Collection<Player> players);
+
+ /**
+ * Damages the itemstack in this slot by the specified amount.
+ * <p>
+ * This runs all logic associated with damaging an itemstack like
+ * gamemode and enchantment checks, events, stat changes, and advancement
+ * triggers.
+ *
+ * @param stack the itemstack to damage
+ * @param amount the amount of damage to do
+ * @return the damaged itemstack, or an empty stack if it broke. There are no
+ * guarantees the returned itemstack is the same instance
+ */
+ @NotNull ItemStack damageItemStack(@NotNull ItemStack stack, int amount);
+
+ /**
+ * Damages the itemstack in this slot by the specified amount.
+ * <p>
+ * This runs all logic associated with damaging an itemstack like
+ * gamemode and enchantment checks, events, stat changes, advancement
+ * triggers, and notifying clients to play break animations.
+ *
+ * @param slot the slot of the stack to damage
+ * @param amount the amount of damage to do
+ */
+ void damageItemStack(org.bukkit.inventory.@NotNull EquipmentSlot slot, int amount);
+ // Paper end - ItemStack damage API
}
diff --git a/src/main/java/org/bukkit/inventory/ItemStack.java b/src/main/java/org/bukkit/inventory/ItemStack.java
index 7eb4cf0b2f162d650252d81e9d38393f69a69046..6195ac25e7a46542659a263c85f7adac745c2ce4 100644
--- a/src/main/java/org/bukkit/inventory/ItemStack.java
+++ b/src/main/java/org/bukkit/inventory/ItemStack.java
@@ -987,5 +987,19 @@ public class ItemStack implements Cloneable, ConfigurationSerializable, Translat
public boolean canRepair(@NotNull ItemStack toBeRepaired) {
return Bukkit.getUnsafe().isValidRepairItemStack(toBeRepaired, this);
}
+
+ /**
+ * Damages this itemstack by the specified amount. This
+ * runs all logic associated with damaging an itemstack like
+ * events and stat changes.
+ *
+ * @param amount the amount of damage to do
+ * @param livingEntity the entity related to the damage
+ * @return the damaged itemstack or an empty one if it broke. May return the same instance of ItemStack
+ * @see org.bukkit.entity.LivingEntity#damageItemStack(EquipmentSlot, int) to damage itemstacks in equipment slots
+ */
+ public @NotNull ItemStack damage(int amount, @NotNull org.bukkit.entity.LivingEntity livingEntity) {
+ return livingEntity.damageItemStack(this, amount);
+ }
// Paper end
}