From 0000000000000000000000000000000000000000 Mon Sep 17 00:00:00 2001 From: Aikar Date: Mon, 6 Nov 2017 21:10:01 -0500 Subject: [PATCH] API to get a BlockState without a snapshot This allows you to get a BlockState without creating a snapshot, operating on the real tile entity. This is useful for where performance is needed diff --git a/src/main/java/org/bukkit/block/Block.java b/src/main/java/org/bukkit/block/Block.java index f440da5941e11c30145175cf24162e1ba2b4e3cf..69d97a14715040263afec77d0ba623c2ac84062a 100644 --- a/src/main/java/org/bukkit/block/Block.java +++ b/src/main/java/org/bukkit/block/Block.java @@ -272,6 +272,16 @@ public interface Block extends Metadatable, Translatable { @NotNull BlockState getState(); + // Paper start + /** + * @see #getState() optionally disables use of snapshot, to operate on real block data + * @param useSnapshot if this block is a TE, should we create a fully copy of the TileEntity + * @return BlockState with the current state of this block + */ + @NotNull + BlockState getState(boolean useSnapshot); + // Paper end + /** * Returns the biome that this block resides in * diff --git a/src/main/java/org/bukkit/block/TileState.java b/src/main/java/org/bukkit/block/TileState.java index 3b10fcc13893403b29f0260b8605144679e89b82..5c8517c5bcae10161952c104b6a4ff7c713bcdbd 100644 --- a/src/main/java/org/bukkit/block/TileState.java +++ b/src/main/java/org/bukkit/block/TileState.java @@ -36,4 +36,18 @@ public interface TileState extends BlockState, PersistentDataHolder { @NotNull @Override PersistentDataContainer getPersistentDataContainer(); + + // Paper start + /** + * Checks if this TileState is a snapshot or a live + * representation of the underlying tile entity. + *

+ * NOTE: You may still have to call {@link BlockState#update()} on + * live representations to update any visuals on the block. + * + * @return true if this is a snapshot + * @see Block#getState(boolean) + */ + boolean isSnapshot(); + // Paper end }