OpenSource/PaperMC
OpenSource/PaperMC
1
0
Fork 0
mirror of https://github.com/PaperMC/Paper.git synced 2025-01-09 11:44:19 +01:00
Code Issues Projects Releases Packages Wiki Activity

Update ChunkSnapshot docs about valid coordinates

Browse source 
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
1 changed files with 12 additions and 12 deletions
Show stats Download patch file Download diff file Expand all files Collapse all files

24
paper-api/src/main/java/org/bukkit/ChunkSnapshot.java
View file

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