mirror of
https://github.com/PaperMC/Paper.git
synced 2024-12-31 00:20:44 +01:00
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
This commit is contained in:
parent
8636a7d5a4
commit
c189c3ba5b
2 changed files with 63 additions and 0 deletions
|
@ -1375,4 +1375,53 @@ public interface LivingEntity extends Attributable, Damageable, ProjectileSource
|
||||||
*/
|
*/
|
||||||
void knockback(double strength, double directionX, double directionZ);
|
void knockback(double strength, double directionX, double directionZ);
|
||||||
// Paper end - knockback API
|
// 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
|
||||||
}
|
}
|
||||||
|
|
|
@ -1090,5 +1090,19 @@ public class ItemStack implements Cloneable, ConfigurationSerializable, Translat
|
||||||
public boolean canRepair(@NotNull ItemStack toBeRepaired) {
|
public boolean canRepair(@NotNull ItemStack toBeRepaired) {
|
||||||
return Bukkit.getUnsafe().isValidRepairItemStack(toBeRepaired, this);
|
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
|
// Paper end
|
||||||
}
|
}
|
||||||
|
|
Loading…
Reference in a new issue