Upstream/Paper
1
0
Fork 0
mirror of https://github.com/PaperMC/Paper.git synced 2024-12-26 19:07:40 +01:00
Code Issues Projects Releases Wiki Activity

Improve Block#breakNaturally API

Browse Source 
Adds bool param to trigger world particle effects

Adds bool param to trigger exp drops for blocks

Co-authored-by: William Blake Galbreath <Blake.Galbreath@GMail.com>
This commit is contained in:
Jake Potrebic 2020-01-02 12:25:16 -06:00
parent 9a251fbd95
commit 1cf2aaef30
1 changed files with 46 additions and 0 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

46
paper-api/src/main/java/org/bukkit/block/Block.java
View File

@ -481,6 +481,52 @@ public interface Block extends Metadatable, Translatable {
*/
boolean breakNaturally(@Nullable ItemStack tool);
// Paper start
/**
* Breaks the block and spawns item drops as if a player had broken it
*
* @param triggerEffect Play the block break particle effect and sound
* @return true if the block was destroyed
* @see #breakNaturally(boolean, boolean) to trigger exp drops
*/
default boolean breakNaturally(boolean triggerEffect) {
return this.breakNaturally(triggerEffect, false);
}
/**
* Breaks the block and spawns item drops as if a player had broken it
*
* @param triggerEffect Play the block break particle effect and sound
* @param dropExperience drop exp if the block normally does so
* @return true if the block was destroyed
*/
boolean breakNaturally(boolean triggerEffect, boolean dropExperience);
/**
* Breaks the block and spawns item drops as if a player had broken it
* with a specific tool
*
* @param tool The tool or item in hand used for digging
* @param triggerEffect Play the block break particle effect and sound
* @return true if the block was destroyed
* @see #breakNaturally(ItemStack, boolean, boolean) to trigger exp drops
*/
default boolean breakNaturally(@NotNull ItemStack tool, boolean triggerEffect) {
return this.breakNaturally(tool, triggerEffect, false);
}
/**
* Breaks the block and spawns item drops as if a player had broken it
* with a specific tool
*
* @param tool The tool or item in hand used for digging
* @param triggerEffect Play the block break particle effect and sound
* @param dropExperience drop exp if the block normally does so
* @return true if the block was destroyed
*/
boolean breakNaturally(@NotNull ItemStack tool, boolean triggerEffect, boolean dropExperience);
// Paper end
/**
* Simulate bone meal application to this block (if possible).
*