io.github.opencubicchunks.cubicchunks.api.world

Interface ICubeProviderServer

All Superinterfaces:

ICubeProvider

@ParametersAreNonnullByDefault
 @MethodsReturnNonnullByDefault
public interface ICubeProviderServer
extends ICubeProvider

Nested Class Summary

Nested Classes

Modifier and Type	Interface and Description
static class	ICubeProviderServer.Requirement The effort made to retrieve a cube or column.

Method Summary

Modifier and Type	Method and Description
net.minecraft.world.chunk.Chunk	getColumn(int columnX, int columnZ, ICubeProviderServer.Requirement req) Retrieve a column.
ICube	getCube(int cubeX, int cubeY, int cubeZ, ICubeProviderServer.Requirement req) Retrieve a cube.
ICube	getCubeNow(int cubeX, int cubeY, int cubeZ, ICubeProviderServer.Requirement req)
boolean	isCubeGenerated(int cubeX, int cubeY, int cubeZ) Returns true if the specified cube has been already generated (either loaded or saved on disk).

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

getCube, getCube, getLoadedColumn, getLoadedCube, getLoadedCube, provideColumn

Method Detail

getColumn

@Nullable
net.minecraft.world.chunk.Chunk getColumn(int columnX,
                                                    int columnZ,
                                                    ICubeProviderServer.Requirement req)

Retrieve a column. The work done to retrieve the column is specified by the ICubeProviderServer.Requirement req

Parameters:

columnX - Column x position

columnZ - Column z position

req - Work done to retrieve the column

Returns:

the column, or null if no column could be created with the specified requirement level

getCube

@Nullable
ICube getCube(int cubeX,
                        int cubeY,
                        int cubeZ,
                        ICubeProviderServer.Requirement req)

Retrieve a cube. The work done to retrieve the cube is specified by ICubeProviderServer.Requirement req

Parameters:

cubeX - the cube's x coordinate

cubeY - the cube's y coordinate

cubeZ - the cube's z coordinate

req - what the requirments are before you get the Cube

Returns:

the Cube or null if no Cube could be found or created

getCubeNow

@Nullable
ICube getCubeNow(int cubeX,
                           int cubeY,
                           int cubeZ,
                           ICubeProviderServer.Requirement req)

isCubeGenerated

boolean isCubeGenerated(int cubeX,
                        int cubeY,
                        int cubeZ)

Returns true if the specified cube has been already generated (either loaded or saved on disk).

Parameters:

cubeX - x coordinate of the cube

cubeY - y coordinate of the cube

cubeZ - z coordinate of the cube

Returns:

true iff, for this position, getCube(int, int, int, Requirement) with ICubeProviderServer.Requirement.LOAD would return a non-null value. The result is guaranteed to be true only if the world save is not corrupted and can otherwise be correctly read.