aboutsummaryrefslogtreecommitdiffhomepage
path: root/Spigot-API-Patches/0182-Add-Heightmap-API.patch
diff options
context:
space:
mode:
authorZach Brown <[email protected]>2019-04-14 07:22:38 -0400
committerZach Brown <[email protected]>2019-04-14 07:22:38 -0400
commit43649ff73aff256714be5380e83b68f1e3aa7901 (patch)
tree81c4aa0b5c857c3c2fcae694b9b9d705d1dd3641 /Spigot-API-Patches/0182-Add-Heightmap-API.patch
parentab8bbdfd8008deb0241d6ed1c62345c24ed34bd8 (diff)
downloadPaper-43649ff73aff256714be5380e83b68f1e3aa7901.tar.gz
Paper-43649ff73aff256714be5380e83b68f1e3aa7901.zip
Fix blocking JavaDoc errors
Diffstat (limited to 'Spigot-API-Patches/0182-Add-Heightmap-API.patch')
-rw-r--r--Spigot-API-Patches/0182-Add-Heightmap-API.patch33
1 files changed, 22 insertions, 11 deletions
diff --git a/Spigot-API-Patches/0182-Add-Heightmap-API.patch b/Spigot-API-Patches/0182-Add-Heightmap-API.patch
index 6fff85ab55..afab0ff3b6 100644
--- a/Spigot-API-Patches/0182-Add-Heightmap-API.patch
+++ b/Spigot-API-Patches/0182-Add-Heightmap-API.patch
@@ -1,4 +1,4 @@
-From 97898e8cdfaafac936acd015cabc188fc8584d97 Mon Sep 17 00:00:00 2001
+From e5544cfd3617bee968c66c49cf81e059cbea7c97 Mon Sep 17 00:00:00 2001
From: Spottedleaf <[email protected]>
Date: Sat, 1 Dec 2018 19:00:36 -0800
Subject: [PATCH] Add Heightmap API
@@ -84,23 +84,27 @@ index 8352b77c..f1263600 100644
* 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..dc9e8a76 100644
+index 107f4173..775aca85 100644
--- a/src/main/java/org/bukkit/World.java
+++ b/src/main/java/org/bukkit/World.java
-@@ -153,6 +153,68 @@ public interface World extends PluginMessageRecipient, Metadatable {
+@@ -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.
++ * <p>
++ * <b>implNote:</b> Implementations are recommended to use an iterative search as a fallback before resorting to
++ * throwing an {@code UnsupportedOperationException}.
++ * </p>
++ *
+ * @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.
-+ * @implNote Implementations are recommended to use an iterative search as a fallback before resorting to
-+ * throwing an {@code UnsupportedOperationException}.
++ *
+ * @see com.destroystokyo.paper.HeightmapType
+ */
+ public int getHighestBlockYAt(int x, int z, @NotNull com.destroystokyo.paper.HeightmapType heightmap) throws UnsupportedOperationException;
@@ -108,12 +112,15 @@ index 107f4173..dc9e8a76 100644
+ /**
+ * 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.
++ * <p>
++ * <b>implNote:</b> Implementations are recommended to use an iterative search as a fallback before resorting to
++ * throwing an {@code UnsupportedOperationException}.
++ * </p>
++ *
+ * @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.
-+ * @implNote Implementations are recommended to use an iterative search as a fallback before resorting to
-+ * throwing an {@code UnsupportedOperationException}.
+ * @see com.destroystokyo.paper.HeightmapType
+ */
+ default int getHighestBlockYAt(@NotNull Location location, @NotNull com.destroystokyo.paper.HeightmapType heightmap) throws UnsupportedOperationException {
@@ -122,13 +129,15 @@ index 107f4173..dc9e8a76 100644
+
+ /**
+ * Returns the highest {@link Block} at the specified block coordinates that match the specified heightmap's conditions.
++ * <p>
++ * <b>implNote:</b> Implementations are recommended to use an iterative search as a fallback before resorting to
++ * throwing an {@code UnsupportedOperationException}.
++ * </p>
+ * @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.
-+ * @implNote Implementations are recommended to use an iterative search as a fallback before resorting to
-+ * throwing an {@code UnsupportedOperationException}.
+ * @see com.destroystokyo.paper.HeightmapType
+ */
+ @NotNull
@@ -139,12 +148,14 @@ index 107f4173..dc9e8a76 100644
+ /**
+ * 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.
++ * <p>
++ * <b>implNote:</b> Implementations are recommended to use an iterative search as a fallback before resorting to
++ * throwing an {@code UnsupportedOperationException}.
++ * </p>
+ * @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.
-+ * @implNote Implementations are recommended to use an iterative search as a fallback before resorting to
-+ * throwing an {@code UnsupportedOperationException}.
+ * @see com.destroystokyo.paper.HeightmapType
+ */
+ @NotNull