From 8306cc5b4fad7f706eab5929c3958e09321c31f3 Mon Sep 17 00:00:00 2001 From: Aikar <aikar@aikar.co> 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 --- .../src/main/java/org/bukkit/block/Block.java | 10 ++++++++++ .../src/main/java/org/bukkit/block/TileState.java | 14 ++++++++++++++ 2 files changed, 24 insertions(+) diff --git a/paper-api/src/main/java/org/bukkit/block/Block.java b/paper-api/src/main/java/org/bukkit/block/Block.java index f440da5941..69d97a1471 100644 --- a/paper-api/src/main/java/org/bukkit/block/Block.java +++ b/paper-api/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/paper-api/src/main/java/org/bukkit/block/TileState.java b/paper-api/src/main/java/org/bukkit/block/TileState.java index 3b10fcc138..5c8517c5bc 100644 --- a/paper-api/src/main/java/org/bukkit/block/TileState.java +++ b/paper-api/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. + * <p> + * 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 }