Interface ChunkLoader

All Known Implementing Classes:

AnvilLoader

public interface ChunkLoader

Interface implemented to change the way chunks are loaded/saved.

See AnvilLoader for the default implementation used in InstanceContainer.

Method Summary

Modifier and Type	Method	Description
@Nullable Chunk	loadChunk(Instance instance, int chunkX, int chunkZ)	Loads a Chunk, all blocks should be set since the Generator is not applied.
default void	loadInstance(Instance instance)	Loads instance data from the loader.
static ChunkLoader	noop()	Returns the no op chunk loader
void	saveChunk(Chunk chunk)	Saves a Chunk with an optional callback for when it is done.
default void	saveChunks(Collection<Chunk> chunks)	Saves multiple chunks with an optional callback for when it is done.
default void	saveInstance(Instance instance)
default boolean	supportsParallelLoading()	Supports for instance/chunk loading in virtual threads.
default boolean	supportsParallelSaving()	Supports for instance/chunk saving in virtual threads.
default void	unloadChunk(Chunk chunk)	Called when a chunk is unloaded, so that this chunk loader can unload any resource it is holding.

Method Details

noop

@Contract(pure=true)
static ChunkLoader noop()

Returns the no op chunk loader

Returns:

the no op loader.

loadInstance

default void loadInstance(Instance instance)

Loads instance data from the loader.

Parameters:

instance - the instance to retrieve the data from

loadChunk

@Nullable
@Nullable Chunk loadChunk(Instance instance,
 int chunkX,
 int chunkZ)

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

Implementations must not initiate another chunk load on the same Instance from this method. Doing so re-enters the instance's loading registry and may fail with an IllegalStateException. If loading a chunk requires data associated with neighboring chunks, read that data directly from the backing storage instead of calling Instance.loadChunk(int, int) or Instance.loadOptionalChunk(int, int).

A loader must never wait for the same chunk it is currently loading. Requests for an in-progress chunk share the existing future, so waiting for that future from this method would wait for the current invocation.

Parameters:

instance - the Instance where the Chunk belong

chunkX - the chunk X

chunkZ - the chunk Z

Returns:

the chunk, or null if not present

saveInstance

default void saveInstance(Instance instance)

saveChunk

void saveChunk(Chunk chunk)

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

Parameters:

chunk - the Chunk to save

saveChunks

default void saveChunks(Collection<Chunk> chunks)

Saves multiple chunks with an optional callback for when it is done.

Implementations need to check supportsParallelSaving() to support the feature if possible.

Parameters:

chunks - the chunks to save

supportsParallelSaving

default boolean supportsParallelSaving()

Supports for instance/chunk saving in virtual threads.

Returns:

true if the chunk loader supports parallel saving

supportsParallelLoading

default boolean supportsParallelLoading()

Supports for instance/chunk loading in virtual threads.

When true, chunks may load in parallel on virtual threads. When false, loadChunk(Instance, int, int) runs synchronously on the thread requesting the load. The re-entrant loading restrictions documented on loadChunk(Instance, int, int) apply in either case.

Returns:

true if the chunk loader supports parallel loading

unloadChunk

default void unloadChunk(Chunk chunk)

Called when a chunk is unloaded, so that this chunk loader can unload any resource it is holding. Note: Minestom currently has no way to determine whether the chunk comes from this loader, so you may get unload requests for chunks not created by the loader.

Parameters:

chunk - the chunk to unload