diff options
| author | md_5 <git@md-5.net> | 2016-08-13 10:17:14 +1000 |
|---|---|---|
| committer | md_5 <git@md-5.net> | 2016-08-13 10:21:48 +1000 |
| commit | b28ed606f6ee1b9b81cb3664f9b8efbdb28280fb (patch) | |
| tree | 7e51149b35e68537b83668da256c79bd7761a2ea | |
| parent | b80c9a0438b876b1b669e047bb1ad94f553fbe75 (diff) | |
| download | bukkit-b28ed606f6ee1b9b81cb3664f9b8efbdb28280fb.tar bukkit-b28ed606f6ee1b9b81cb3664f9b8efbdb28280fb.tar.gz bukkit-b28ed606f6ee1b9b81cb3664f9b8efbdb28280fb.tar.lz bukkit-b28ed606f6ee1b9b81cb3664f9b8efbdb28280fb.tar.xz bukkit-b28ed606f6ee1b9b81cb3664f9b8efbdb28280fb.zip | |
SPIGOT-2595: Clarify World#getHighestBlockYAt behaviour
| -rw-r--r-- | src/main/java/org/bukkit/World.java | 15 |
1 files changed, 10 insertions, 5 deletions
diff --git a/src/main/java/org/bukkit/World.java b/src/main/java/org/bukkit/World.java index 9d71de4b..c14840a2 100644 --- a/src/main/java/org/bukkit/World.java +++ b/src/main/java/org/bukkit/World.java @@ -71,16 +71,19 @@ public interface World extends PluginMessageRecipient, Metadatable { public int getBlockTypeIdAt(Location location); /** - * Gets the highest non-air coordinate at the given coordinates + * 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. * * @param x X-coordinate of the blocks * @param z Z-coordinate of the blocks - * @return Y-coordinate of the highest non-air block + * @return Y-coordinate of the described block */ public int getHighestBlockYAt(int x, int z); /** - * Gets the highest non-air coordinate at the given {@link Location} + * Gets the y coordinate of the lowest block at the given {@link Location} + * such that the block and all blocks above it are transparent for lighting + * purposes. * * @param location Location of the blocks * @return Y-coordinate of the highest non-air block @@ -88,7 +91,8 @@ public interface World extends PluginMessageRecipient, Metadatable { public int getHighestBlockYAt(Location location); /** - * Gets the highest non-empty block at the given coordinates + * Gets the lowest block at the given coordinates such that the block and + * all blocks above it are transparent for lighting purposes. * * @param x X-coordinate of the block * @param z Z-coordinate of the block @@ -97,7 +101,8 @@ public interface World extends PluginMessageRecipient, Metadatable { public Block getHighestBlockAt(int x, int z); /** - * Gets the highest non-empty block at the given coordinates + * Gets the lowest block at the given {@link Location} such that the block + * and all blocks above it are transparent for lighting purposes. * * @param location Coordinates to get the highest block * @return Highest non-empty block |