Update ChunkSnapshot docs about valid coordinates

By: md_5 <git@md-5.net>
This commit is contained in:
Bukkit/Spigot 2018-08-29 07:43:54 +10:00
parent ee106c043e
commit 3b7907251d

View file

@ -36,7 +36,7 @@ public interface ChunkSnapshot {
* Get block type for block at corresponding coordinate in the chunk
*
* @param x 0-15
* @param y 0-127
* @param y 0-255
* @param z 0-15
* @return block material type
*/
@ -46,7 +46,7 @@ public interface ChunkSnapshot {
* Get block data for block at corresponding coordinate in the chunk
*
* @param x 0-15
* @param y 0-127
* @param y 0-255
* @param z 0-15
* @return block material type
*/
@ -56,7 +56,7 @@ public interface ChunkSnapshot {
* Get block data for block at corresponding coordinate in the chunk
*
* @param x 0-15
* @param y 0-127
* @param y 0-255
* @param z 0-15
* @return 0-15
* @deprecated Magic value
@ -68,7 +68,7 @@ public interface ChunkSnapshot {
* Get sky light level for block at corresponding coordinate in the chunk
*
* @param x 0-15
* @param y 0-127
* @param y 0-255
* @param z 0-15
* @return 0-15
*/
@ -79,7 +79,7 @@ public interface ChunkSnapshot {
* chunk
*
* @param x 0-15
* @param y 0-127
* @param y 0-255
* @param z 0-15
* @return 0-15
*/
@ -88,8 +88,8 @@ public interface ChunkSnapshot {
/**
* Gets the highest non-air coordinate at the given coordinates
*
* @param x X-coordinate of the blocks
* @param z Z-coordinate of the blocks
* @param x X-coordinate of the blocks (0-15)
* @param z Z-coordinate of the blocks (0-15)
* @return Y-coordinate of the highest non-air block
*/
int getHighestBlockYAt(int x, int z);
@ -97,8 +97,8 @@ public interface ChunkSnapshot {
/**
* Get biome at given coordinates
*
* @param x X-coordinate
* @param z Z-coordinate
* @param x X-coordinate (0-15)
* @param z Z-coordinate (0-15)
* @return Biome at given coordinate
*/
Biome getBiome(int x, int z);
@ -106,8 +106,8 @@ public interface ChunkSnapshot {
/**
* Get raw biome temperature (0.0-1.0) at given coordinate
*
* @param x X-coordinate
* @param z Z-coordinate
* @param x X-coordinate (0-15)
* @param z Z-coordinate (0-15)
* @return temperature at given coordinate
*/
double getRawBiomeTemperature(int x, int z);
@ -122,7 +122,7 @@ public interface ChunkSnapshot {
/**
* Test if section is empty
*
* @param sy - section Y coordinate (block Y / 16)
* @param sy - section Y coordinate (block Y / 16, 0-255)
* @return true if empty, false if not
*/
boolean isSectionEmpty(int sy);