Package net.minestom.server.instance

Class AnvilLoader

java.lang.Object

net.minestom.server.instance.AnvilLoader

All Implemented Interfaces:

IChunkLoader

public class AnvilLoader
extends Object
implements IChunkLoader

Constructor Summary

Constructors

Constructor	Description
AnvilLoader(@NotNull String path)
AnvilLoader(@NotNull Path path)

Method Summary

Modifier and Type	Method	Description
@NotNull CompletableFuture<@Nullable Chunk>	loadChunk(@NotNull Instance instance, int chunkX, int chunkZ)	Loads a Chunk, all blocks should be set since the ChunkGenerator is not applied.
void	loadInstance(@NotNull Instance instance)	Loads instance data from the loader.
@NotNull CompletableFuture<Void>	saveChunk(@NotNull Chunk chunk)	Saves a Chunk with an optional callback for when it is done.
@NotNull CompletableFuture<Void>	saveInstance(@NotNull Instance instance)
boolean	supportsParallelLoading()	Does this IChunkLoader allow for multi-threaded loading of Chunk?
boolean	supportsParallelSaving()	Does this IChunkLoader allow for multi-threaded saving of Chunk?
void	unloadChunk(Chunk chunk)	Unload a given 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

AnvilLoader

public AnvilLoader(@NotNull
 @NotNull Path path)

AnvilLoader

public AnvilLoader(@NotNull
 @NotNull String path)

Method Details

loadInstance

public void loadInstance(@NotNull
 @NotNull Instance instance)

Description copied from interface: IChunkLoader

Loads instance data from the loader.

Specified by:

loadInstance in interface IChunkLoader

Parameters:

instance - the instance to retrieve the data from

loadChunk

@NotNull
public @NotNull CompletableFuture<@Nullable Chunk> loadChunk(@NotNull
 @NotNull Instance instance,
 int chunkX,
 int chunkZ)

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

Returns:

a CompletableFuture containing the chunk, or null if not present

saveInstance

@NotNull
public @NotNull CompletableFuture<Void> saveInstance(@NotNull
 @NotNull Instance instance)

Specified by:

saveInstance in interface IChunkLoader

saveChunk

@NotNull
public @NotNull CompletableFuture<Void> saveChunk(@NotNull
 @NotNull Chunk chunk)

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

Returns:

a CompletableFuture executed when the Chunk is done saving, should be called even if the saving failed (you can throw an exception).

unloadChunk

public void unloadChunk(Chunk chunk)

Unload a given chunk. Also unloads a region when no chunk from that region is loaded.

Specified by:

unloadChunk in interface IChunkLoader

Parameters:

chunk - the chunk to unload

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

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