io.github.opencubicchunks.cubicchunks.api.world

Interface IHeightMap

@ParametersAreNonnullByDefault
 @MethodsReturnNonnullByDefault
public interface IHeightMap

Nested Class Summary

Nested Classes

Modifier and Type	Interface and Description
static class	IHeightMap.HeightMap

Method Summary

Modifier and Type	Method and Description
int	getLowestTopBlockY() Out of the highest non-opaque blocks from all block columns in the column, returns the y-coordinate of the lowest block.
int	getTopBlockY(int localX, int localZ) Returns the y-coordinate of the highest non-transparent block in the specified block-column.
int	getTopBlockYBelow(int localX, int localZ, int blockY) Deprecated.
default boolean	isOccluded(int localX, int blockY, int localZ) Returns true if the block at the given position is occluded by a known non-opaque block further up.
void	onOpacityChange(int localX, int blockY, int localZ, int opacity) Sets the opacity at the given position to the given value.

Method Detail

onOpacityChange

void onOpacityChange(int localX,
                     int blockY,
                     int localZ,
                     int opacity)

Sets the opacity at the given position to the given value.

Parameters:

localX - local block x-coordinate (0..15)

blockY - global block y-coordinate

localZ - local block z-coordinate (0..15)

opacity - new opacity (0..255)

isOccluded

default boolean isOccluded(int localX,
                           int blockY,
                           int localZ)

Returns true if the block at the given position is occluded by a known non-opaque block further up.

Parameters:

localX - local block x-coordinate (0..15)

blockY - global block y-coordinate

localZ - local block z-coordinate (0..15)

Returns:

true if there exists a known non-opaque block above the given y-coordinate

getTopBlockY

int getTopBlockY(int localX,
                 int localZ)

Returns the y-coordinate of the highest non-transparent block in the specified block-column.

Parameters:

localX - local block x-coordinate (0..15)

localZ - local block z-coordinate (0..15)

Returns:

Y position of the top non-transparent block, or very low (far below the min world height) if one doesn't exist

getTopBlockYBelow

@Deprecated
int getTopBlockYBelow(int localX,
                                  int localZ,
                                  int blockY)

Deprecated.

Returns the y-coordinate of the highest non-transparent block that is below the given blockY.

Parameters:

localX - local block x-coordinate (0..15)

localZ - local block z-coordinate (0..15)

blockY - only positions below or at this Y coordinate will be retuirned

Returns:

Y position of the top non-transparent block below blockY, or very low (far below the min world height) if one doesn't exist

getLowestTopBlockY

int getLowestTopBlockY()

Out of the highest non-opaque blocks from all block columns in the column, returns the y-coordinate of the lowest block.

Returns:

the minimum of all top block coordinates in this heightmap instance