spigot-mirror/bukkit
1
0
Fork 0
mirror of https://hub.spigotmc.org/stash/scm/spigot/bukkit.git synced 2025-08-31 22:22:49 +00:00
Code Issues Projects Releases Packages Wiki Activity Actions

SPIGOT-2595: Clarify World#getHighestBlockYAt behaviour

Browse source
This commit is contained in:
md_5 2016-08-13 10:17:14 +10:00
parent b80c9a0438
commit b28ed606f6
1 changed files with 10 additions and 5 deletions
Show stats Download patch file Download diff file Expand all files Collapse all files

15
src/main/java/org/bukkit/World.java
View file

@ -71,16 +71,19 @@ public interface World extends PluginMessageRecipient, Metadatable {
public int getBlockTypeIdAt(Location location); 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 x X-coordinate of the blocks
* @param z Z-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); 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 * @param location Location of the blocks
* @return Y-coordinate of the highest non-air block * @return Y-coordinate of the highest non-air block
@ -88,7 +91,8 @@ public interface World extends PluginMessageRecipient, Metadatable {
public int getHighestBlockYAt(Location location); 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 x X-coordinate of the block
* @param z Z-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); 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 * @param location Coordinates to get the highest block
* @return Highest non-empty block * @return Highest non-empty block