Package net.minestom.server.instance

Class MinestomBasicChunkLoader

java.lang.Object

net.minestom.server.instance.MinestomBasicChunkLoader

All Implemented Interfaces:

IChunkLoader

public class MinestomBasicChunkLoader
extends java.lang.Object
implements IChunkLoader

A IChunkLoader used by InstanceContainer which is based on the StorageLocation and ChunkSupplier associated to it.

It simply save chunk serialized data from Chunk.getSerializedData() and deserialize it later with Chunk.readChunk(BinaryReader, ChunkCallback).

The key used in the StorageLocation is defined by getChunkKey(int, int) and should NOT be changed.

Constructor Summary

Constructors

Constructor	Description
MinestomBasicChunkLoader(InstanceContainer instanceContainer)	Creates an IChunkLoader which use a StorageLocation.

Method Summary

Modifier and Type	Method	Description
boolean	loadChunk(Instance instance, int chunkX, int chunkZ, ChunkCallback callback)	Loads a Chunk, all blocks should be set since the ChunkGenerator is not applied.
void	saveChunk(Chunk chunk, java.lang.Runnable callback)	Saves a Chunk with an optional callback for when it is done.
boolean	supportsParallelLoading()	Does this IChunkLoader allow for multi-threaded loading of Chunk?
boolean	supportsParallelSaving()	Does this IChunkLoader allow for multi-threaded saving of Chunk?

Methods inherited from class java.lang.Object

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

Methods inherited from interface net.minestom.server.instance.IChunkLoader

saveChunks

Constructor Details

MinestomBasicChunkLoader

public MinestomBasicChunkLoader(InstanceContainer instanceContainer)

Creates an IChunkLoader which use a StorageLocation.

The ChunkSupplier is used to customize which type of Chunk this loader should use for loading.

WARNING: Chunk implementations do not need to have the same serializing format, be careful.

Parameters:

instanceContainer - the InstanceContainer linked to this loader

Method Details

saveChunk

public void saveChunk(@NotNull Chunk chunk, @Nullable java.lang.Runnable callback)

Description copied from interface: IChunkLoader

Saves a Chunk with an optional callback for when it is done.

Specified by:

saveChunk in interface IChunkLoader

Parameters:

chunk - the Chunk to save

callback - the callback executed when the Chunk is done saving, should be called even if the saving failed (you can throw an exception). Can be null.

loadChunk

public boolean loadChunk(@NotNull Instance instance, int chunkX, int chunkZ, @Nullable ChunkCallback callback)

Description copied from interface: IChunkLoader

Loads a Chunk, all blocks should be set since the ChunkGenerator is not applied.

Specified by:

loadChunk in interface IChunkLoader

Parameters:

instance - the Instance where the Chunk belong

chunkX - the chunk X

chunkZ - the chunk Z

callback - the callback executed when the Chunk is done loading, never called if the method returns false. Can be null.

Returns:

true if the chunk loaded successfully, false otherwise

supportsParallelSaving

public boolean supportsParallelSaving()

Description copied from interface: IChunkLoader

Does this IChunkLoader allow for multi-threaded saving of Chunk?

Specified by:

supportsParallelSaving in interface IChunkLoader

Returns:

true if the chunk loader supports parallel saving

supportsParallelLoading

public boolean supportsParallelLoading()

Description copied from interface: IChunkLoader

Does this IChunkLoader allow for multi-threaded loading of Chunk?

Specified by:

supportsParallelLoading in interface IChunkLoader

Returns:

true if the chunk loader supports parallel loading