From e5544cfd3617bee968c66c49cf81e059cbea7c97 Mon Sep 17 00:00:00 2001 From: Spottedleaf Date: Sat, 1 Dec 2018 19:00:36 -0800 Subject: [PATCH] Add Heightmap API diff --git a/src/main/java/com/destroystokyo/paper/HeightmapType.java b/src/main/java/com/destroystokyo/paper/HeightmapType.java new file mode 100644 index 00000000..4cd9b5ed --- /dev/null +++ b/src/main/java/com/destroystokyo/paper/HeightmapType.java @@ -0,0 +1,35 @@ +package com.destroystokyo.paper; + +import org.bukkit.World; + +/** + * Enumeration of different heightmap types maintained by the server. Generally using these maps is much faster + * than using an iterative search for a block in a given x, z coordinate. + */ +public enum HeightmapType { + + /** + * The highest block used for lighting in the world. Also the block returned by {@link World#getHighestBlockYAt(int, int)}} + */ + LIGHT_BLOCKING, + + /** + * References the highest block in the world. + */ + ANY, + + /** + * References the highest solid block in a world. + */ + SOLID, + + /** + * References the highest solid or liquid block in a world. + */ + SOLID_OR_LIQUID, + + /** + * References the highest solid or liquid block in a world, excluding leaves. + */ + SOLID_OR_LIQUID_NO_LEAVES; +} diff --git a/src/main/java/org/bukkit/Location.java b/src/main/java/org/bukkit/Location.java index 8352b77c..f1263600 100644 --- a/src/main/java/org/bukkit/Location.java +++ b/src/main/java/org/bukkit/Location.java @@ -610,6 +610,33 @@ public class Location implements Cloneable, ConfigurationSerializable { return centerLoc; } + // Paper start - Add heightmap api + + /** + * Returns a copy of this location except with y = getWorld().getHighestBlockYAt(this.getBlockX(), this.getBlockZ()) + * @return A copy of this location except with y = getWorld().getHighestBlockYAt(this.getBlockX(), this.getBlockZ()) + * @throws NullPointerException if {{@link #getWorld()}} is {@code null} + */ + @NotNull + public Location toHighestLocation() { + return this.toHighestLocation(com.destroystokyo.paper.HeightmapType.LIGHT_BLOCKING); + } + + /** + * Returns a copy of this location except with y = getWorld().getHighestBlockYAt(this.getBlockX(), this.getBlockZ(), heightmap) + * @param heightmap The heightmap to use for finding the highest y location. + * @return A copy of this location except with y = getWorld().getHighestBlockYAt(this.getBlockX(), this.getBlockZ(), heightmap) + * @throws NullPointerException if {{@link #getWorld()}} is {@code null} + * @throws UnsupportedOperationException if {@link World#getHighestBlockYAt(int, int, com.destroystokyo.paper.HeightmapType)} does not support the specified heightmap + */ + @NotNull + public Location toHighestLocation(@NotNull final com.destroystokyo.paper.HeightmapType heightmap) { + final Location ret = this.clone(); + ret.setY(this.getWorld().getHighestBlockYAt(this, heightmap)); + return ret; + } + // Paper end + /** * Creates explosion at this location with given power * diff --git a/src/main/java/org/bukkit/World.java b/src/main/java/org/bukkit/World.java index 107f4173..775aca85 100644 --- a/src/main/java/org/bukkit/World.java +++ b/src/main/java/org/bukkit/World.java @@ -153,6 +153,79 @@ public interface World extends PluginMessageRecipient, Metadatable { @NotNull public Block getHighestBlockAt(@NotNull Location location); + // Paper start - Add heightmap API + /** + * Returns the highest block's y-coordinate at the specified block coordinates that match the specified heightmap's conditions. + *

+ * implNote: Implementations are recommended to use an iterative search as a fallback before resorting to + * throwing an {@code UnsupportedOperationException}. + *

+ * + * @param x The block's x-coordinate. + * @param z The block's z-coordinate. + * @param heightmap The specified heightmap to use. See {@link com.destroystokyo.paper.HeightmapType} + * @return The highest block's y-coordinate at (x, z) that matches the specified heightmap's conditions. + * @throws UnsupportedOperationException If the heightmap type is not supported. + * + * @see com.destroystokyo.paper.HeightmapType + */ + public int getHighestBlockYAt(int x, int z, @NotNull com.destroystokyo.paper.HeightmapType heightmap) throws UnsupportedOperationException; + + /** + * Returns the highest block's y-coordinate at the specified block coordinates that match the specified heightmap's conditions. + * Note that the y-coordinate of the specified location is ignored. + *

+ * implNote: Implementations are recommended to use an iterative search as a fallback before resorting to + * throwing an {@code UnsupportedOperationException}. + *

+ * + * @param location The specified block coordinates. + * @param heightmap The specified heightmap to use. See {@link com.destroystokyo.paper.HeightmapType} + * @return The highest block's y-coordinate at {@code location} that matches the specified heightmap's conditions. + * @throws UnsupportedOperationException If the heightmap type is not supported. + * @see com.destroystokyo.paper.HeightmapType + */ + default int getHighestBlockYAt(@NotNull Location location, @NotNull com.destroystokyo.paper.HeightmapType heightmap) throws UnsupportedOperationException { + return this.getHighestBlockYAt(location.getBlockX(), location.getBlockZ(), heightmap); + } + + /** + * Returns the highest {@link Block} at the specified block coordinates that match the specified heightmap's conditions. + *

+ * implNote: Implementations are recommended to use an iterative search as a fallback before resorting to + * throwing an {@code UnsupportedOperationException}. + *

+ * @param x The block's x-coordinate. + * @param z The block's z-coordinate. + * @param heightmap The specified heightmap to use. See {@link com.destroystokyo.paper.HeightmapType} + * @return The highest {@link Block} at (x, z) that matches the specified heightmap's conditions. + * @throws UnsupportedOperationException If the heightmap type is not supported. + * @see com.destroystokyo.paper.HeightmapType + */ + @NotNull + default Block getHighestBlockAt(int x, int z, @NotNull com.destroystokyo.paper.HeightmapType heightmap) throws UnsupportedOperationException { + return this.getBlockAt(x, this.getHighestBlockYAt(x, z, heightmap), z); + } + + /** + * Returns the highest {@link Block} at the specified block coordinates that match the specified heightmap's conditions. + * Note that the y-coordinate of the specified location is ignored. + *

+ * implNote: Implementations are recommended to use an iterative search as a fallback before resorting to + * throwing an {@code UnsupportedOperationException}. + *

+ * @param location The specified block coordinates. + * @param heightmap The specified heightmap to use. See {@link com.destroystokyo.paper.HeightmapType} + * @return The highest {@link Block} at {@code location} that matches the specified heightmap's conditions. + * @throws UnsupportedOperationException If the heightmap type is not supported. + * @see com.destroystokyo.paper.HeightmapType + */ + @NotNull + default Block getHighestBlockAt(@NotNull Location location, @NotNull com.destroystokyo.paper.HeightmapType heightmap) throws UnsupportedOperationException { + return this.getHighestBlockAt(location.getBlockX(), location.getBlockZ(), heightmap); + } + // Paper end + /** * Gets the {@link Chunk} at the given coordinates * -- 2.21.0