io.github.opencubicchunks.cubicchunks.api.world

Interface ICubicWorldServer

All Superinterfaces:

ICubicWorld, IMinMaxHeight

@ParametersAreNonnullByDefault
 @MethodsReturnNonnullByDefault
public interface ICubicWorldServer
extends ICubicWorld

Nested Class Summary

Nested classes/interfaces inherited from interface io.github.opencubicchunks.cubicchunks.api.world.ICubicWorld

ICubicWorld.SurfaceType

Method Summary

Modifier and Type	Method and Description
void	forceChunk(net.minecraftforge.common.ForgeChunkManager.Ticket ticket, CubePos chunk) CubicChunks equivalent of ForgeChunkManager.forceChunk(ForgeChunkManager.Ticket, ChunkPos).
ICubeProviderServer	getCubeCache() Returns the ICubeProvider for this world, or throws NotCubicChunksWorldException if this is not a CubicChunks world.
ICubeGenerator	getCubeGenerator()
void	reorderChunk(net.minecraftforge.common.ForgeChunkManager.Ticket ticket, CubePos chunk) CubicChunks equivalent of ForgeChunkManager.reorderChunk(ForgeChunkManager.Ticket, ChunkPos) Can accept tickets from different worlds.
void	unforceChunk(net.minecraftforge.common.ForgeChunkManager.Ticket ticket, CubePos chunk) CubicChunks equivalent of ForgeChunkManager.unforceChunk(ForgeChunkManager.Ticket, ChunkPos) Can accept tickets from different worlds.
void	unloadOldCubes() Unloads or schedules unloading of no longer needed chunks from the world.

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

canBeTopBlock, findTopBlock, findTopBlock, getActualHeight, getCubeFromBlockCoords, getCubeFromCubeCoords, getCubeFromCubeCoords, getEffectiveHeight, getMaxGenerationHeight, getMinGenerationHeight, getSurfaceForCube, getSurfaceForCube, isBlockColumnLoaded, isBlockColumnLoaded, isCubicWorld, testForCubes, testForCubes, testForCubes

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

getMaxHeight, getMinHeight

Method Detail

getCubeCache

ICubeProviderServer getCubeCache()

Description copied from interface: ICubicWorld

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

Specified by:

getCubeCache in interface ICubicWorld

Returns:

the cube provider

getCubeGenerator

ICubeGenerator getCubeGenerator()

unloadOldCubes

void unloadOldCubes()

Unloads or schedules unloading of no longer needed chunks from the world. Use of this should generally be avoided, as this is done automatically. There are generally only a few valid uses of this method: * Generating a lot of new chunks (for example pregenerating terrain) * On user command Note: there are known bugs caused by this method in some situations, that cause a chunk that contains a player to be unloaded when the player is moving at very high speed. This is very unlikely to happen and has never been reported outside of artificially created test setup with special player movement code. This issue is probably not fixable. Automatic chunk unloading is not affected.

forceChunk

void forceChunk(net.minecraftforge.common.ForgeChunkManager.Ticket ticket,
                CubePos chunk)

CubicChunks equivalent of ForgeChunkManager.forceChunk(ForgeChunkManager.Ticket, ChunkPos). Can accept tickets from different worlds.

Parameters:

ticket - ForgeChunkManager ticket

chunk - position of the cube to force load

reorderChunk

void reorderChunk(net.minecraftforge.common.ForgeChunkManager.Ticket ticket,
                  CubePos chunk)

CubicChunks equivalent of ForgeChunkManager.reorderChunk(ForgeChunkManager.Ticket, ChunkPos) Can accept tickets from different worlds.

Parameters:

ticket - ForgeChunkManager ticket

chunk - position of the cube to reorder

unforceChunk

void unforceChunk(net.minecraftforge.common.ForgeChunkManager.Ticket ticket,
                  CubePos chunk)

CubicChunks equivalent of ForgeChunkManager.unforceChunk(ForgeChunkManager.Ticket, ChunkPos) Can accept tickets from different worlds.

Parameters:

ticket - ForgeChunkManager ticket

chunk - position of the cube to unforce