io.github.opencubicchunks.cubicchunks.api.world

Interface ICubicWorld

All Superinterfaces:

IMinMaxHeight

All Known Subinterfaces:

ICubicWorldServer

@MethodsReturnNonnullByDefault
 @ParametersAreNonnullByDefault
public interface ICubicWorld
extends IMinMaxHeight

Nested Class Summary

Nested Classes

Modifier and Type	Interface and Description
static class	ICubicWorld.SurfaceType

Method Summary

Modifier and Type	Method and Description
default boolean	canBeTopBlock(net.minecraft.util.math.BlockPos pos, net.minecraft.block.state.IBlockState state, ICubicWorld.SurfaceType type)
default net.minecraft.util.math.BlockPos	findTopBlock(net.minecraft.util.math.BlockPos start, int minTopY, int maxTopY, java.util.function.BiPredicate<net.minecraft.util.math.BlockPos,net.minecraft.block.state.IBlockState> canBeTopBlock) Finds the top block between minTopY and maxTopY, startiung the search at start.
default net.minecraft.util.math.BlockPos	findTopBlock(net.minecraft.util.math.BlockPos start, int minTopY, int maxTopY, ICubicWorld.SurfaceType type)
int	getActualHeight() Return the actual world height for this world.
ICubeProvider	getCubeCache() Returns the ICubeProvider for this world, or throws NotCubicChunksWorldException if this is not a CubicChunks world.
ICube	getCubeFromBlockCoords(net.minecraft.util.math.BlockPos pos)
default ICube	getCubeFromCubeCoords(CubePos pos)
ICube	getCubeFromCubeCoords(int cubeX, int cubeY, int cubeZ)
int	getEffectiveHeight(int blockX, int blockZ)
int	getMaxGenerationHeight()
int	getMinGenerationHeight()
default net.minecraft.util.math.BlockPos	getSurfaceForCube(CubePos pos, int xOffset, int zOffset, int forcedAdditionalCubes, java.util.function.BiPredicate<net.minecraft.util.math.BlockPos,net.minecraft.block.state.IBlockState> canBeTopBlock)
default net.minecraft.util.math.BlockPos	getSurfaceForCube(CubePos cubePos, int xOffset, int zOffset, int forcedAdditionalCubes, ICubicWorld.SurfaceType type) Finds the top block for that population cube with given offset, or null if no suitable place found.
boolean	isBlockColumnLoaded(net.minecraft.util.math.BlockPos pos)
boolean	isBlockColumnLoaded(net.minecraft.util.math.BlockPos pos, boolean allowEmpty)
boolean	isCubicWorld()
default boolean	testForCubes(net.minecraft.util.math.BlockPos centerPos, int blockRadius, java.util.function.Predicate<ICube> test) Returns true iff the given Predicate evaluates to true for all cubes for block positions within blockRadius from centerPos.
boolean	testForCubes(CubePos start, CubePos end, java.util.function.Predicate<? super ICube> test) Returns true iff the given Predicate evaluates to true for given cube and neighbors.
default boolean	testForCubes(int minBlockX, int minBlockY, int minBlockZ, int maxBlockX, int maxBlockY, int maxBlockZ, java.util.function.Predicate<ICube> test) Returns true iff the given Predicate evaluates to true for all cubes for block positions between BlockPos(minBlockX, minBlockY, minBlockZ) and BlockPos(maxBlockX, maxBlockY, maxBlockZ) (including the specified positions).

Methods inherited from interface io.github.opencubicchunks.cubicchunks.api.world.IMinMaxHeight

getMaxHeight, getMinHeight

Method Detail

isCubicWorld

boolean isCubicWorld()

getCubeCache

ICubeProvider getCubeCache()

Returns the ICubeProvider for this world, or throws NotCubicChunksWorldException if this is not a CubicChunks world.

Returns:

the cube provider

getSurfaceForCube

default net.minecraft.util.math.BlockPos getSurfaceForCube(CubePos cubePos,
                                                           int xOffset,
                                                           int zOffset,
                                                           int forcedAdditionalCubes,
                                                           ICubicWorld.SurfaceType type)

Finds the top block for that population cube with given offset, or null if no suitable place found. This method starts from the top of population area (or forcedAdditionalCubes*16 blocks above that) and goes down scanning for solid block. The value is used only if it's within population area. Note: forcedAdditionalCubes should be zero unless absolutely necessary.

Parameters:

cubePos - cube position to find surface for

xOffset - x coordinate of population area offset relative to cube origin

zOffset - z coordinate of population area offset relative to cube origin

forcedAdditionalCubes - amount of additional cubes above to scan

type - surface type

Returns:

position of the block above the top block matching criteria specified by surface type, or null if it doesn't exist

getSurfaceForCube

@Nullable
default net.minecraft.util.math.BlockPos getSurfaceForCube(CubePos pos,
                                                                     int xOffset,
                                                                     int zOffset,
                                                                     int forcedAdditionalCubes,
                                                                     java.util.function.BiPredicate<net.minecraft.util.math.BlockPos,net.minecraft.block.state.IBlockState> canBeTopBlock)

findTopBlock

@Nullable
default net.minecraft.util.math.BlockPos findTopBlock(net.minecraft.util.math.BlockPos start,
                                                                int minTopY,
                                                                int maxTopY,
                                                                ICubicWorld.SurfaceType type)

findTopBlock

@Nullable
default net.minecraft.util.math.BlockPos findTopBlock(net.minecraft.util.math.BlockPos start,
                                                                int minTopY,
                                                                int maxTopY,
                                                                java.util.function.BiPredicate<net.minecraft.util.math.BlockPos,net.minecraft.block.state.IBlockState> canBeTopBlock)

Finds the top block between minTopY and maxTopY, startiung the search at start. If a potential top block is found above maxTopY, this method returns null. Note that canBeTopBlock should return true even if you don't intend to generate something when that block is encountered as long as it counts as "surface".

Parameters:

start - start position

minTopY - minimum Y coordinate to search

maxTopY - maximum Y coordinate to consider as a surface

canBeTopBlock - checks whether a block at given position should be considered "surface".

Returns:

the top found position

canBeTopBlock

default boolean canBeTopBlock(net.minecraft.util.math.BlockPos pos,
                              net.minecraft.block.state.IBlockState state,
                              ICubicWorld.SurfaceType type)

testForCubes

default boolean testForCubes(net.minecraft.util.math.BlockPos centerPos,
                             int blockRadius,
                             java.util.function.Predicate<ICube> test)

Returns true iff the given Predicate evaluates to true for all cubes for block positions within blockRadius from centerPos. Only cubes that exist are tested. If some cubes within that range aren't loaded - returns false.

Parameters:

centerPos - position to start at

blockRadius - radius in block to test, starting from centerPos

test - the test to apply

Returns:

false if any invokation of the given predicate returns false, true otherwise

testForCubes

default boolean testForCubes(int minBlockX,
                             int minBlockY,
                             int minBlockZ,
                             int maxBlockX,
                             int maxBlockY,
                             int maxBlockZ,
                             java.util.function.Predicate<ICube> test)

Returns true iff the given Predicate evaluates to true for all cubes for block positions between BlockPos(minBlockX, minBlockY, minBlockZ) and BlockPos(maxBlockX, maxBlockY, maxBlockZ) (including the specified positions). Only cubes that exist are tested. If some cubes within that range aren't loaded - returns false.

Parameters:

minBlockX - minimum block x coordinate

minBlockY - minimum block y coordinate

minBlockZ - minimum block z coordinate

maxBlockX - maximum block x coordinate

maxBlockY - maximum block y coordinate

maxBlockZ - maximum block z coordinate

test - the test to apply

Returns:

false if any invokation of the given predicate returns false, true otherwise

testForCubes

boolean testForCubes(CubePos start,
                     CubePos end,
                     java.util.function.Predicate<? super ICube> test)

Returns true iff the given Predicate evaluates to true for given cube and neighbors. Only cubes that exist are tested. If some cubes within that range aren't loaded - returns false.

Parameters:

start - start cube position

end - end cube position

test - the test to apply

Returns:

false if any invokation of the given predicate returns false, true otherwise

getActualHeight

int getActualHeight()

Return the actual world height for this world. Typically this is 256 for worlds with a sky, and 128 for worlds without.

Returns:

The actual world height

getCubeFromCubeCoords

ICube getCubeFromCubeCoords(int cubeX,
                            int cubeY,
                            int cubeZ)

getCubeFromCubeCoords

default ICube getCubeFromCubeCoords(CubePos pos)

getCubeFromBlockCoords

ICube getCubeFromBlockCoords(net.minecraft.util.math.BlockPos pos)

getEffectiveHeight

int getEffectiveHeight(int blockX,
                       int blockZ)

isBlockColumnLoaded

boolean isBlockColumnLoaded(net.minecraft.util.math.BlockPos pos)

isBlockColumnLoaded

boolean isBlockColumnLoaded(net.minecraft.util.math.BlockPos pos,
                            boolean allowEmpty)

getMinGenerationHeight

int getMinGenerationHeight()

getMaxGenerationHeight

int getMaxGenerationHeight()