From 0000000000000000000000000000000000000000 Mon Sep 17 00:00:00 2001 From: Ineusia <ineusia@yahoo.com> Date: Mon, 26 Oct 2020 11:37:48 -0500 Subject: [PATCH] Add Destroy Speed API Co-authored-by: Jake Potrebic <jake.m.potrebic@gmail.com> diff --git a/src/main/java/org/bukkit/block/Block.java b/src/main/java/org/bukkit/block/Block.java index 25db31b2e9a6d75f0c59f75237842f9ad7d1c350..75c2aadb0a2baebe8b2625ad11b16380285d65c5 100644 --- a/src/main/java/org/bukkit/block/Block.java +++ b/src/main/java/org/bukkit/block/Block.java @@ -690,4 +690,31 @@ public interface Block extends Metadatable, Translatable, net.kyori.adventure.tr @Deprecated(forRemoval = true) String getTranslationKey(); // Paper end + + // Paper start - destroy speed API + /** + * Gets the speed at which this block will be destroyed by a given {@link ItemStack} + * <p> + * Default value is 1.0 + * + * @param itemStack {@link ItemStack} used to mine this Block + * @return the speed that this Block will be mined by the given {@link ItemStack} + */ + default float getDestroySpeed(final @NotNull ItemStack itemStack) { + return this.getBlockData().getDestroySpeed(itemStack); + } + + /** + * Gets the speed at which this block will be destroyed by a given {@link ItemStack} + * <p> + * Default value is 1.0 + * + * @param itemStack {@link ItemStack} used to mine this Block + * @param considerEnchants true to look at enchants on the itemstack + * @return the speed that this Block will be mined by the given {@link ItemStack} + */ + default float getDestroySpeed(@NotNull ItemStack itemStack, boolean considerEnchants) { + return this.getBlockData().getDestroySpeed(itemStack, considerEnchants); + } + // Paper end - destroy speed API } diff --git a/src/main/java/org/bukkit/block/data/BlockData.java b/src/main/java/org/bukkit/block/data/BlockData.java index cd3b3e05cc825cfedec07f9a2a1e0b7b2a8866d6..890a511355dd3f2aa9330fdc72c0fb4b3e44e5cb 100644 --- a/src/main/java/org/bukkit/block/data/BlockData.java +++ b/src/main/java/org/bukkit/block/data/BlockData.java @@ -266,4 +266,33 @@ public interface BlockData extends Cloneable { @NotNull @ApiStatus.Experimental BlockState createBlockState(); + + // Paper start - destroy speed API + /** + * Gets the speed at which this block will be destroyed by a given {@link ItemStack} + * <p> + * Default value is 1.0 + * + * @param itemStack {@link ItemStack} used to mine this Block + * @return the speed that this Block will be mined by the given {@link ItemStack} + * @apiNote this method assumes default player state and hence, e.g., does not take into account changed + * player attributes or potion effects. + */ + default float getDestroySpeed(final @NotNull ItemStack itemStack) { + return this.getDestroySpeed(itemStack, false); + } + + /** + * Gets the speed at which this block will be destroyed by a given {@link ItemStack} + * <p> + * Default value is 1.0 + * + * @param itemStack {@link ItemStack} used to mine this Block + * @param considerEnchants true to look at enchants on the itemstack + * @return the speed that this Block will be mined by the given {@link ItemStack} + * @apiNote this method assumes default player state and hence, e.g., does not take into account changed + * player attributes or potion effects. + */ + float getDestroySpeed(@NotNull ItemStack itemStack, boolean considerEnchants); + // Paper end - destroy speed API }