aboutsummaryrefslogtreecommitdiffhomepage
path: root/patches/api/0180-Improve-Block-breakNaturally-API.patch
blob: 54820995ca604c04afd066969f271017ac7f8b4e (plain)
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
From 0000000000000000000000000000000000000000 Mon Sep 17 00:00:00 2001
From: Jake Potrebic <jake.m.potrebic@gmail.com>
Date: Thu, 2 Jan 2020 12:25:16 -0600
Subject: [PATCH] Improve Block#breakNaturally API

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>

diff --git a/src/main/java/org/bukkit/block/Block.java b/src/main/java/org/bukkit/block/Block.java
index f468e9751f75fd355512e033c180de967de5b2d8..bf29d9b733afc7c62725d259f4920c4f211cc6d0 100644
--- a/src/main/java/org/bukkit/block/Block.java
+++ b/src/main/java/org/bukkit/block/Block.java
@@ -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).
      *