Paper/Spigot-API-Patches/0137-Allow-Blocks-to-be-accessed-via-a-long-key.patch

173 lines
5.8 KiB
Diff
Raw Normal View History

From 039fde9628b4eb210babf96765eb25678fda8959 Mon Sep 17 00:00:00 2001
From: Spottedleaf <Spottedleaf@users.noreply.github.com>
Date: Tue, 14 Aug 2018 21:42:10 -0700
Subject: [PATCH] Allow Blocks to be accessed via a long key
The key can be retrieved via methods Location#toBlockKey() and
Block#getBlockKey()
World provides lookup for blocks by long key via method World#getBlockAtKey(long)
The formatting for the key is as follows:
10 bit y|27 bit z|27 bit x
The y value is considered unsigned while z and x are considered two's complement
Y range: [0, 1023]
X, Z range: [-67 108 864, 67 108 863]
diff --git a/src/main/java/org/bukkit/Location.java b/src/main/java/org/bukkit/Location.java
index 884862ab..6dc39989 100644
--- a/src/main/java/org/bukkit/Location.java
+++ b/src/main/java/org/bukkit/Location.java
2019-05-06 04:58:04 +02:00
@@ -15,7 +15,6 @@ import org.jetbrains.annotations.Nullable;
// Paper start
import java.util.Collection;
-import java.util.Collections;
import java.util.function.Predicate;
import org.bukkit.entity.Entity;
import org.bukkit.entity.LivingEntity;
2019-05-06 04:58:04 +02:00
@@ -605,6 +604,17 @@ public class Location implements Cloneable, ConfigurationSerializable {
blockLoc.setZ(getBlockZ());
return blockLoc;
}
+
+ // Paper Start
+ /**
+ * @return The block key for this location's block location.
+ * @see Block#getBlockKey(int, int, int)
+ */
+ public long toBlockKey() {
+ return Block.getBlockKey(getBlockX(), getBlockY(), getBlockZ());
+ }
+ // Paper End
+
/**
* @return A new location where X/Y/Z are the center of the block
*/
diff --git a/src/main/java/org/bukkit/World.java b/src/main/java/org/bukkit/World.java
index d4fcbf60..ce128016 100644
--- a/src/main/java/org/bukkit/World.java
+++ b/src/main/java/org/bukkit/World.java
@@ -89,6 +89,38 @@ public interface World extends PluginMessageRecipient, Metadatable {
@NotNull
public Block getBlockAt(@NotNull Location location);
+ // Paper start
+ /**
+ * Gets the {@link Block} at the given block key
+ *
+ * @param key The block key. See {@link Block#getBlockKey()}
+ * @return Block at the key
+ * @see Block#getBlockKey(int, int, int)
+ */
+ @NotNull
+ public default Block getBlockAtKey(long key) {
+ int x = Block.getBlockKeyX(key);
+ int y = Block.getBlockKeyY(key);
+ int z = Block.getBlockKeyZ(key);
+ return getBlockAt(x, y, z);
+ }
+
+ /**
+ * Gets the {@link Location} at the given block key
+ *
+ * @param key The block key. See {@link Location#toBlockKey()}
+ * @return Location at the key
+ * @see Block#getBlockKey(int, int, int)
+ */
+ @NotNull
+ public default Location getLocationAtKey(long key) {
+ int x = Block.getBlockKeyX(key);
+ int y = Block.getBlockKeyY(key);
+ int z = Block.getBlockKeyZ(key);
+ return new Location(this, x, y, z);
+ }
+ // Paper end
+
/**
2018-08-18 10:59:57 +02:00
* Gets the y coordinate of the lowest block at this position such that the
* block and all blocks above it are transparent for lighting purposes.
diff --git a/src/main/java/org/bukkit/block/Block.java b/src/main/java/org/bukkit/block/Block.java
index af4ffada..87185a81 100644
--- a/src/main/java/org/bukkit/block/Block.java
+++ b/src/main/java/org/bukkit/block/Block.java
2019-04-23 06:47:07 +02:00
@@ -152,6 +152,72 @@ public interface Block extends Metadatable {
*/
int getZ();
+ // Paper Start
+ /**
+ * Returns this block's coordinates packed into a long value.
+ * Computed via: {@code Block.getBlockKey(this.getX(), this.getY(), this.getZ())}
+ * @see Block#getBlockKey(int, int, int)
+ * @return This block's x, y, and z coordinates packed into a long value
+ */
+ public default long getBlockKey() {
+ return Block.getBlockKey(this.getX(), this.getY(), this.getZ());
+ }
+
+ /**
+ * Returns the specified block coordinates packed into a long value
2018-10-25 15:38:19 +02:00
+ * <p>
+ * The return value can be computed as follows:
2018-10-25 15:38:19 +02:00
+ * <br>
+ * {@code long value = ((long)x & 0x7FFFFFF) | (((long)z & 0x7FFFFFF) << 27) | ((long)y << 54);}
2018-10-25 15:38:19 +02:00
+ * </p>
+ *
+ * <p>
+ * And may be unpacked as follows:
+ * <br>
+ * {@code int x = (int) ((packed << 37) >> 37);}
2018-10-25 15:38:19 +02:00
+ * <br>
+ * {@code int y = (int) (packed >>> 54);}
2018-10-25 15:38:19 +02:00
+ * <br>
+ * {@code int z = (int) ((packed << 10) >> 37);}
2018-10-25 15:38:19 +02:00
+ * </p>
+ *
+ * @return This block's x, y, and z coordinates packed into a long value
+ */
+ public static long getBlockKey(int x, int y, int z) {
+ return ((long)x & 0x7FFFFFF) | (((long)z & 0x7FFFFFF) << 27) | ((long)y << 54);
+ }
+
+ /**
+ * Returns the x component from the packed value.
+ * @param packed The packed value, as computed by {@link Block#getBlockKey(int, int, int)}
+ * @see Block#getBlockKey(int, int, int)
+ * @return The x component from the packed value.
+ */
+ public static int getBlockKeyX(long packed) {
+ return (int) ((packed << 37) >> 37);
+ }
+
+ /**
+ * Returns the y component from the packed value.
+ * @param packed The packed value, as computed by {@link Block#getBlockKey(int, int, int)}
+ * @see Block#getBlockKey(int, int, int)
+ * @return The y component from the packed value.
+ */
+ public static int getBlockKeyY(long packed) {
+ return (int) (packed >>> 54);
+ }
+
+ /**
+ * Returns the z component from the packed value.
+ * @param packed The packed value, as computed by {@link Block#getBlockKey(int, int, int)}
+ * @see Block#getBlockKey(int, int, int)
+ * @return The z component from the packed value.
+ */
+ public static int getBlockKeyZ(long packed) {
+ return (int) ((packed << 10) >> 37);
+ }
+ // Paper End
+
/**
* Gets the Location of the block
*
--
2.22.0