Paper/Spigot-API-Patches/0247-Additional-Block-Material-API-s.patch
Aikar 7bfb781ff3
Additional Block Material API's
Faster version for isSolid() that utilizes NMS's state for isSolid instead of the slower
process to do this in the Bukkit API

Material#isSolid uses a large switch statement which isn't as performant vs a simple boolean return

Adds API for buildable, replaceable, burnable too.
2020-12-30 19:43:45 -05:00

58 lines
2.0 KiB
Diff

From 0000000000000000000000000000000000000000 Mon Sep 17 00:00:00 2001
From: Aikar <aikar@aikar.co>
Date: Wed, 30 Dec 2020 17:27:27 -0500
Subject: [PATCH] Additional Block Material API's
Faster version for isSolid() that utilizes NMS's state for isSolid instead of the slower
process to do this in the Bukkit API
Adds API for buildable, replaceable, burnable too.
diff --git a/src/main/java/org/bukkit/block/Block.java b/src/main/java/org/bukkit/block/Block.java
index 6933fd6ad353a2d008c4a64c52a64bf36bd8035c..0c72d00ad238ab69d7ae0941e3ecb6c86e71624d 100644
--- a/src/main/java/org/bukkit/block/Block.java
+++ b/src/main/java/org/bukkit/block/Block.java
@@ -427,6 +427,42 @@ public interface Block extends Metadatable {
*/
boolean isLiquid();
+ // Paper start
+ /**
+ * Check if this block is solid
+ * <p>
+ * Determined by Minecraft, typically a block a player can use to place a new block to build things.
+ * An example of a non buildable block would be liquids, flowers, or fire
+ *
+ * @return true if block is buildable
+ */
+ boolean isBuildable();
+ /**
+ * Check if this block is burnable
+ * <p>
+ * Determined by Minecraft, typically a block that fire can destroy (Wool, Wood)
+ *
+ * @return true if block is burnable
+ */
+ boolean isBurnable();
+ /**
+ * Check if this block is replaceable
+ * <p>
+ * Determined by Minecraft, representing a block that is not AIR that you can still place a new block at, such as flowers.
+ * @return true if block is replaceable
+ */
+ boolean isReplaceable();
+ /**
+ * Check if this block is solid
+ * <p>
+ * Determined by Minecraft, typically a block a player can stand on and can't be passed through.
+ *
+ * This API is faster than accessing Material#isSolid as it avoids a material lookup and switch statement.
+ * @return true if block is solid
+ */
+ boolean isSolid();
+ // Paper end
+
/**
* Gets the temperature of this block.
* <p>