Commits

md_5 authored b28ed606f6e
SPIGOT-2595: Clarify World#getHighestBlockYAt behaviour
No tags

src/main/java/org/bukkit/World.java

Modified
64 64 * @param location Location of the block
65 65 * @return Type ID of the block at the given location
66 66 * @see #getBlockAt(org.bukkit.Location) Returns a live Block object at
67 67 * the given location
68 68 * @deprecated Magic value
69 69 */
70 70 @Deprecated
71 71 public int getBlockTypeIdAt(Location location);
72 72
73 73 /**
74 - * Gets the highest non-air coordinate at the given coordinates
74 + * Gets the y coordinate of the lowest block at this position such that the
75 + * block and all blocks above it are transparent for lighting purposes.
75 76 *
76 77 * @param x X-coordinate of the blocks
77 78 * @param z Z-coordinate of the blocks
78 - * @return Y-coordinate of the highest non-air block
79 + * @return Y-coordinate of the described block
79 80 */
80 81 public int getHighestBlockYAt(int x, int z);
81 82
82 83 /**
83 - * Gets the highest non-air coordinate at the given {@link Location}
84 + * Gets the y coordinate of the lowest block at the given {@link Location}
85 + * such that the block and all blocks above it are transparent for lighting
86 + * purposes.
84 87 *
85 88 * @param location Location of the blocks
86 89 * @return Y-coordinate of the highest non-air block
87 90 */
88 91 public int getHighestBlockYAt(Location location);
89 92
90 93 /**
91 - * Gets the highest non-empty block at the given coordinates
94 + * Gets the lowest block at the given coordinates such that the block and
95 + * all blocks above it are transparent for lighting purposes.
92 96 *
93 97 * @param x X-coordinate of the block
94 98 * @param z Z-coordinate of the block
95 99 * @return Highest non-empty block
96 100 */
97 101 public Block getHighestBlockAt(int x, int z);
98 102
99 103 /**
100 - * Gets the highest non-empty block at the given coordinates
104 + * Gets the lowest block at the given {@link Location} such that the block
105 + * and all blocks above it are transparent for lighting purposes.
101 106 *
102 107 * @param location Coordinates to get the highest block
103 108 * @return Highest non-empty block
104 109 */
105 110 public Block getHighestBlockAt(Location location);
106 111
107 112 /**
108 113 * Gets the {@link Chunk} at the given coordinates
109 114 *
110 115 * @param x X-coordinate of the chunk

Everything looks good. We'll let you know here if there's anything you should know about.

Add shortcut