mirror of
https://github.com/PaperMC/Paper.git
synced 2024-12-11 09:23:42 +01:00
90 lines
3.9 KiB
Diff
90 lines
3.9 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 eced9bfd35aa822b1ba141ea60e603bca5a137f8..088f42f294784e14f4478255193f4fd40cba4e53 100644
|
|
--- a/src/main/java/org/bukkit/entity/LivingEntity.java
|
|
+++ b/src/main/java/org/bukkit/entity/LivingEntity.java
|
|
@@ -1170,5 +1170,52 @@ public interface LivingEntity extends Attributable, Damageable, ProjectileSource
|
|
* @param directionZ The relative z position of the knockback source direction
|
|
*/
|
|
void knockback(double strength, double directionX, double directionZ);
|
|
+
|
|
+ /**
|
|
+ * 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
|
|
}
|
|
diff --git a/src/main/java/org/bukkit/inventory/ItemStack.java b/src/main/java/org/bukkit/inventory/ItemStack.java
|
|
index eac7adf622b91489711a2f8bcff77fb31292dd67..d15a74c38576c49df61cfab02c70fc5d8c0dd5f7 100644
|
|
--- a/src/main/java/org/bukkit/inventory/ItemStack.java
|
|
+++ b/src/main/java/org/bukkit/inventory/ItemStack.java
|
|
@@ -971,5 +971,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
|
|
}
|