io.github.opencubicchunks.cubicchunks.core.server

Class CubeProviderServer

java.lang.Object

net.minecraft.world.gen.ChunkProviderServer

io.github.opencubicchunks.cubicchunks.core.server.CubeProviderServer

All Implemented Interfaces:

ICubeProvider, ICubeProviderServer, ICubeProviderInternal, ICubeProviderInternal.Server, net.minecraft.world.chunk.IChunkProvider

@MethodsReturnNonnullByDefault
 @ParametersAreNonnullByDefault
public class CubeProviderServer
extends net.minecraft.world.gen.ChunkProviderServer
implements ICubeProviderServer, ICubeProviderInternal.Server

This is CubicChunks equivalent of ChunkProviderServer, it loads and unloads Cubes and Columns.

There are a few necessary changes to the way vanilla methods work: * Because loading a Chunk (Column) doesn't make much sense with CubicChunks, all methods that load Chunks, actually load an empry column with no blocks in it (there may be some entities that are not in any Cube yet). * dropChunk method is not supported. Columns are unloaded automatically when the last cube is unloaded

Nested Class Summary

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

ICubeProviderServer.Requirement

Nested classes/interfaces inherited from interface io.github.opencubicchunks.cubicchunks.core.world.ICubeProviderInternal

ICubeProviderInternal.Server

Field Summary

Fields inherited from class net.minecraft.world.gen.ChunkProviderServer

chunkGenerator, chunkLoader, loadedChunks, world

Constructor Summary

Constructors

Constructor and Description
CubeProviderServer(net.minecraft.world.WorldServer worldServer, ICubeGenerator cubeGen)

Method Summary

Modifier and Type	Method and Description
void	asyncGetColumn(int columnX, int columnZ, ICubeProviderServer.Requirement req, java.util.function.Consumer<net.minecraft.world.chunk.Chunk> callback) Retrieve a column, asynchronously.
void	asyncGetCube(int cubeX, int cubeY, int cubeZ, ICubeProviderServer.Requirement req, java.util.function.Consumer<Cube> callback) Load a cube, asynchronously.
boolean	chunkExists(int cubeX, int cubeZ)
java.lang.String	dumpLoadedCubes()
net.minecraft.world.chunk.Chunk	getColumn(int columnX, int columnZ, ICubeProviderServer.Requirement req) Retrieve a column.
Cube	getCube(CubePos coords)
Cube	getCube(int cubeX, int cubeY, int cubeZ)
Cube	getCube(int cubeX, int cubeY, int cubeZ, ICubeProviderServer.Requirement req) Retrieve a cube.
ICubeGenerator	getCubeGenerator()
ICubeIO	getCubeIO()
Cube	getCubeNow(int cubeX, int cubeY, int cubeZ, ICubeProviderServer.Requirement req)
net.minecraft.world.chunk.Chunk	getLoadedChunk(int columnX, int columnZ) Deprecated.
net.minecraft.world.chunk.Chunk	getLoadedColumn(int columnX, int columnZ) Vanilla method, returns a Chunk (Column) only of it's already loaded.
Cube	getLoadedCube(CubePos coords)
Cube	getLoadedCube(int cubeX, int cubeY, int cubeZ)
int	getLoadedCubeCount()
net.minecraft.util.math.BlockPos	getNearestStructurePos(net.minecraft.world.World worldIn, java.lang.String name, net.minecraft.util.math.BlockPos pos, boolean findUnexplored)
java.util.List<net.minecraft.world.biome.Biome.SpawnListEntry>	getPossibleCreatures(net.minecraft.entity.EnumCreatureType type, net.minecraft.util.math.BlockPos pos)
boolean	isCubeGenerated(int cubeX, int cubeY, int cubeZ) Returns true if the specified cube has been already generated (either loaded or saved on disk).
boolean	isInsideStructure(net.minecraft.world.World p_193413_1_, java.lang.String p_193413_2_, net.minecraft.util.math.BlockPos p_193413_3_)
net.minecraft.world.chunk.Chunk	loadChunk(int columnX, int columnZ) Deprecated.
net.minecraft.world.chunk.Chunk	loadChunk(int columnX, int columnZ, java.lang.Runnable runnable) Deprecated.
java.lang.String	makeString()
net.minecraft.world.chunk.Chunk	provideChunk(int cubeX, int cubeZ) Deprecated.
net.minecraft.world.chunk.Chunk	provideColumn(int cubeX, int cubeZ) If this Column is already loaded - returns it.
void	queueUnload(net.minecraft.world.chunk.Chunk chunk)
void	queueUnloadAll()
boolean	saveChunks(boolean alwaysTrue)
boolean	tick()

Methods inherited from class net.minecraft.world.gen.ChunkProviderServer

canSave, flushToDisk, getLoadedChunkCount, getLoadedChunks, isChunkGeneratedAt

Methods inherited from class java.lang.Object

clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

Constructor Detail

CubeProviderServer

public CubeProviderServer(net.minecraft.world.WorldServer worldServer,
                          ICubeGenerator cubeGen)

Method Detail

queueUnload

@Detainted
public void queueUnload(net.minecraft.world.chunk.Chunk chunk)

Overrides:

queueUnload in class net.minecraft.world.gen.ChunkProviderServer

queueUnloadAll

@Detainted
public void queueUnloadAll()

Overrides:

queueUnloadAll in class net.minecraft.world.gen.ChunkProviderServer

getLoadedColumn

@Nullable
public net.minecraft.world.chunk.Chunk getLoadedColumn(int columnX,
                                                                 int columnZ)

Vanilla method, returns a Chunk (Column) only of it's already loaded.

Specified by:

getLoadedColumn in interface ICubeProvider

Parameters:

columnX - The x position of the column

columnZ - The z position of the column

Returns:

The column, if loaded. Null, otherwise.

getLoadedChunk

@Nullable
 @Deprecated
public net.minecraft.world.chunk.Chunk getLoadedChunk(int columnX,
                                                                             int columnZ)

Deprecated.

Specified by:

getLoadedChunk in interface net.minecraft.world.chunk.IChunkProvider

Overrides:

getLoadedChunk in class net.minecraft.world.gen.ChunkProviderServer

loadChunk

@Nullable
 @Deprecated
public net.minecraft.world.chunk.Chunk loadChunk(int columnX,
                                                                        int columnZ)

Deprecated.

Loads Chunk (Column) if it can be loaded from disk, or returns already loaded one. Doesn't generate new Columns.

Overrides:

loadChunk in class net.minecraft.world.gen.ChunkProviderServer

loadChunk

@Nullable
 @Deprecated
public net.minecraft.world.chunk.Chunk loadChunk(int columnX,
                                                                        int columnZ,
                                                                        @Nullable
                                                                        java.lang.Runnable runnable)

Deprecated.

Load chunk asynchronously. Currently CubicChunks only loads synchronously.

Overrides:

loadChunk in class net.minecraft.world.gen.ChunkProviderServer

provideColumn

public net.minecraft.world.chunk.Chunk provideColumn(int cubeX,
                                                     int cubeZ)

If this Column is already loaded - returns it. Loads from disk if possible, otherwise generates new Column.

Specified by:

provideColumn in interface ICubeProvider

provideChunk

@Deprecated
public net.minecraft.world.chunk.Chunk provideChunk(int cubeX,
                                                                int cubeZ)

Deprecated.

Specified by:

provideChunk in interface net.minecraft.world.chunk.IChunkProvider

Overrides:

provideChunk in class net.minecraft.world.gen.ChunkProviderServer

saveChunks

public boolean saveChunks(boolean alwaysTrue)

Overrides:

saveChunks in class net.minecraft.world.gen.ChunkProviderServer

tick

public boolean tick()

Specified by:

tick in interface net.minecraft.world.chunk.IChunkProvider

Overrides:

tick in class net.minecraft.world.gen.ChunkProviderServer

makeString

public java.lang.String makeString()

Specified by:

makeString in interface net.minecraft.world.chunk.IChunkProvider

Overrides:

makeString in class net.minecraft.world.gen.ChunkProviderServer

getPossibleCreatures

public java.util.List<net.minecraft.world.biome.Biome.SpawnListEntry> getPossibleCreatures(net.minecraft.entity.EnumCreatureType type,
                                                                                           net.minecraft.util.math.BlockPos pos)

Overrides:

getPossibleCreatures in class net.minecraft.world.gen.ChunkProviderServer

getNearestStructurePos

@Nullable
public net.minecraft.util.math.BlockPos getNearestStructurePos(net.minecraft.world.World worldIn,
                                                                         java.lang.String name,
                                                                         net.minecraft.util.math.BlockPos pos,
                                                                         boolean findUnexplored)

Overrides:

getNearestStructurePos in class net.minecraft.world.gen.ChunkProviderServer

chunkExists

public boolean chunkExists(int cubeX,
                           int cubeZ)

Overrides:

chunkExists in class net.minecraft.world.gen.ChunkProviderServer

isInsideStructure

public boolean isInsideStructure(net.minecraft.world.World p_193413_1_,
                                 java.lang.String p_193413_2_,
                                 net.minecraft.util.math.BlockPos p_193413_3_)

Overrides:

isInsideStructure in class net.minecraft.world.gen.ChunkProviderServer

getCube

public Cube getCube(int cubeX,
                    int cubeY,
                    int cubeZ)

Specified by:

getCube in interface ICubeProvider

Specified by:

getCube in interface ICubeProviderInternal

getCube

public Cube getCube(CubePos coords)

Specified by:

getCube in interface ICubeProvider

Specified by:

getCube in interface ICubeProviderInternal

getLoadedCube

@Nullable
public Cube getLoadedCube(int cubeX,
                                    int cubeY,
                                    int cubeZ)

Specified by:

getLoadedCube in interface ICubeProvider

Specified by:

getLoadedCube in interface ICubeProviderInternal

getLoadedCube

@Nullable
public Cube getLoadedCube(CubePos coords)

Specified by:

getLoadedCube in interface ICubeProvider

Specified by:

getLoadedCube in interface ICubeProviderInternal

asyncGetCube

public void asyncGetCube(int cubeX,
                         int cubeY,
                         int cubeZ,
                         ICubeProviderServer.Requirement req,
                         java.util.function.Consumer<Cube> callback)

Load a cube, asynchronously. The work done to retrieve the column is specified by the Requirement req

Parameters:

cubeX - Cube x position

cubeY - Cube y position

cubeZ - Cube z position

req - Work done to retrieve the column

callback - Callback to be called when the load finishes. Note that null can be passed to the callback if the work specified by req is not sufficient to provide a cube

See Also:

for the synchronous equivalent to this method

getCube

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

Description copied from interface: ICubeProviderServer

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

Specified by:

getCube in interface ICubeProviderServer

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
public Cube getCubeNow(int cubeX,
                                 int cubeY,
                                 int cubeZ,
                                 ICubeProviderServer.Requirement req)

Specified by:

getCubeNow in interface ICubeProviderServer

isCubeGenerated

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

Description copied from interface: ICubeProviderServer

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

Specified by:

isCubeGenerated in interface ICubeProviderServer

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, ICubeProviderServer.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.

asyncGetColumn

public void asyncGetColumn(int columnX,
                           int columnZ,
                           ICubeProviderServer.Requirement req,
                           java.util.function.Consumer<net.minecraft.world.chunk.Chunk> callback)

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

Parameters:

columnX - Column x position

columnZ - Column z position

req - Work done to retrieve the column

callback - Callback to be called when the column has finished loading. Note that the returned column is not guaranteed to be non-null

See Also:

for the synchronous variant of this method

getColumn

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

Description copied from interface: ICubeProviderServer

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

Specified by:

getColumn in interface ICubeProviderServer

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

dumpLoadedCubes

public java.lang.String dumpLoadedCubes()

getCubeIO

@Nonnull
public ICubeIO getCubeIO()

Specified by:

getCubeIO in interface ICubeProviderInternal.Server

getCubeGenerator

public ICubeGenerator getCubeGenerator()

getLoadedCubeCount

public int getLoadedCubeCount()