io.github.opencubicchunks.cubicchunks.api.world

Interface IColumn

All Superinterfaces:

XZAddressable

@ParametersAreNonnullByDefault
 @MethodsReturnNonnullByDefault
public interface IColumn
extends XZAddressable

Method Summary

Modifier and Type	Method and Description
void	addCube(ICube cube) Add a cube to this column
ICube	getCube(int cubeY) Retrieve the cube at the specified location
int	getHeight(net.minecraft.util.math.BlockPos pos) Return Y position of the block directly above the top non-transparent block (opacity != 0), or a value below minimum world height of there is no top block.
int	getHeightValue(int localX, int localZ) Deprecated. Use getHeightValue(int, int, int) instead
int	getHeightValue(int localX, int blockY, int localZ) Return Y position of the block directly above the top non-transparent block, or a value below minimum world height of there is no top block.
ICube	getLoadedCube(int cubeY) Retrieve the cube at the specified location if it is loaded.
java.util.Collection<? extends ICube>	getLoadedCubes() Retrieve all cubes in this column that are currently loaded
java.lang.Iterable<? extends ICube>	getLoadedCubes(int startY, int endY) Iterate over all loaded cubes in this column in order.
IHeightMap	getOpacityIndex()
boolean	hasLoadedCubes() Check if there are any loaded cube in this column
void	preCacheCube(ICube cube) Note: this method is intended for internal use only and will be removed.
ICube	removeCube(int cubeY) Remove the cube at the specified height
boolean	shouldTick() Check if this column needs to be ticked

Methods inherited from interface io.github.opencubicchunks.cubicchunks.api.util.XZAddressable

getX, getZ

Method Detail

getHeight

int getHeight(net.minecraft.util.math.BlockPos pos)

Return Y position of the block directly above the top non-transparent block (opacity != 0), or a value below minimum world height of there is no top block.

Parameters:

pos - the position for which the height should be returned. Note that Y coordinate may not necessarily be ignored, which gives the possibility of multiple layers/stacked dimensions

Returns:

Y coordinate of the block directly above the top non-transparent block

getHeightValue

@Deprecated
int getHeightValue(int localX,
                               int localZ)

Deprecated. Use getHeightValue(int, int, int) instead

Return Y position of the block directly above the top non-transparent block, or a value below minimum world height of there is no top block.

Parameters:

localX - x coordinate relative to this chunk. Only values in range [0, ICube.SIZE) are valid

localZ - z coordinate relative to this chunk. Only values in range [0, ICube.SIZE) are valid

Returns:

Height at specified X and Z coordinates

getHeightValue

int getHeightValue(int localX,
                   int blockY,
                   int localZ)

Return Y position of the block directly above the top non-transparent block, or a value below minimum world height of there is no top block.

Parameters:

localX - x coordinate relative to this chunk. Only values in range [0, ICube.SIZE) are valid

blockY - the Y for which the height should be returned. This is global world coordinate, not a local coordinate. Note that Y coordinate may not necessarily be ignored, which gives the possibility of multiple layers/stacked dimensions

localZ - z coordinate relative to this chunk. Only values in range [0, ICube.SIZE) are valid

Returns:

Height at specified X and Z coordinates

shouldTick

boolean shouldTick()

Check if this column needs to be ticked

Returns:

true if any cube in this column needs to be ticked, false otherwise

getOpacityIndex

IHeightMap getOpacityIndex()

Returns:

the height map of this column

getLoadedCubes

java.util.Collection<? extends ICube> getLoadedCubes()

Retrieve all cubes in this column that are currently loaded

Returns:

the cubes

getLoadedCubes

java.lang.Iterable<? extends ICube> getLoadedCubes(int startY,
                                                   int endY)

Iterate over all loaded cubes in this column in order. If startY < endY, order is bottom to top, otherwise order is top to bottom.

Parameters:

startY - initial cube y position

endY - last cube y position

Returns:

an iterator over all loaded cubes between startY and endY (inclusive)

getLoadedCube

@Nullable
ICube getLoadedCube(int cubeY)

Retrieve the cube at the specified location if it is loaded.

Parameters:

cubeY - cube y position

Returns:

the cube at that position, or null if it is not loaded

getCube

ICube getCube(int cubeY)

Retrieve the cube at the specified location

Parameters:

cubeY - cube y position

Returns:

the cube at that position

addCube

void addCube(ICube cube)

Add a cube to this column

Parameters:

cube - the cube being added

removeCube

@Nullable
ICube removeCube(int cubeY)

Remove the cube at the specified height

Parameters:

cubeY - cube y position

Returns:

the removed cube if it existed, otherwise null

hasLoadedCubes

boolean hasLoadedCubes()

Check if there are any loaded cube in this column

Returns:

true if there is at least on loaded cube in this column, false otherwise

preCacheCube

void preCacheCube(ICube cube)

Note: this method is intended for internal use only and will be removed. Make the chunk ready to use this cube for the next block operation. This cube will be used only if the coordinates match.

Parameters:

cube - the cube to precache