twin/paper-mc
1
0
Fork 0
mirror of https://github.com/PaperMC/Paper.git synced 2025-08-11 10:12:06 -07:00
Code Issues Packages Projects Releases Wiki Activity

SPIGOT-5523: Clarify getHighestBlock docs with current behaviour

Browse Source 
By: md_5 <git@md-5.net>
This commit is contained in:
Bukkit/Spigot
2020-01-22 08:58:47 +11:00
parent eb35e8f1d1
commit 902b81e2dd
1 changed files with 8 additions and 11 deletions
Download Patch File Download Diff File Expand all files Collapse all files

19
paper-api/src/main/java/org/bukkit/World.java
View File

@@ -60,28 +60,26 @@ public interface World extends PluginMessageRecipient, Metadatable {
public Block getBlockAt(@NotNull Location location); public Block getBlockAt(@NotNull Location location);
/** /**
* Gets the y coordinate of the lowest block at this position such that the * Gets the highest non-empty (impassable) coordinate at the given
* block and all blocks above it are transparent for lighting purposes. * coordinates.
* *
* @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 described block * @return Y-coordinate of the highest non-empty block
*/ */
public int getHighestBlockYAt(int x, int z); public int getHighestBlockYAt(int x, int z);
/** /**
* Gets the y coordinate of the lowest block at the given {@link Location} * Gets the highest non-empty (impassable) coordinate at the given
* such that the block and all blocks above it are transparent for lighting * {@link Location}.
* 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-empty block
*/ */
public int getHighestBlockYAt(@NotNull Location location); public int getHighestBlockYAt(@NotNull Location location);
/** /**
* Gets the lowest block at the given coordinates such that the block and * Gets the highest non-empty (impassable) block at the given coordinates.
* 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
@@ -91,8 +89,7 @@ public interface World extends PluginMessageRecipient, Metadatable {
public Block getHighestBlockAt(int x, int z); public Block getHighestBlockAt(int x, int z);
/** /**
* Gets the lowest block at the given {@link Location} such that the block * Gets the highest non-empty (impassable) block at the given coordinates.
* 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