Package org.cloudburstmc.server.level.provider

Interface LevelProvider

All Superinterfaces:

AutoCloseable, Closeable, PlayerDataProvider

All Known Implementing Classes:

ConversionProvider

@ParametersAreNonnullByDefault
public interface LevelProvider
extends PlayerDataProvider, Closeable

Interface that allows the level to load and save chunks from any storage implementation.

Method Summary

Modifier and Type	Method	Description
CompletableFuture<Void>	forEachChunk(ChunkBuilder.Factory factory, BiConsumer<CloudChunk,Throwable> consumer)	Iterate over all chunks that the provider has.
String	getLevelId()	Level ID
CompletableFuture<LoadState>	loadLevelData(LevelData levelData)	Load level data into given LevelData object
CompletableFuture<CloudChunk>	readChunk(ChunkBuilder chunkBuilder)	Reads chunk from provider asynchronously
CompletableFuture<Void>	saveChunk(org.cloudburstmc.api.level.chunk.Chunk chunk)	Saves chunk to provider asynchronously
CompletableFuture<Void>	saveLevelData(LevelData levelData)	Save level data from given LevelData object

Methods inherited from interface java.io.Closeable

close

Method Details

getLevelId

String getLevelId()

Level ID

Returns:

id

readChunk

CompletableFuture<CloudChunk> readChunk(ChunkBuilder chunkBuilder)

Reads chunk from provider asynchronously

Parameters:

chunkBuilder - builder

Returns:

future when chunk is loaded. Will return null if the chunk does not exist

saveChunk

CompletableFuture<Void> saveChunk(org.cloudburstmc.api.level.chunk.Chunk chunk)

Saves chunk to provider asynchronously

Parameters:

chunk - chunk

Returns:

void future when chunk is saved.

forEachChunk

CompletableFuture<Void> forEachChunk(ChunkBuilder.Factory factory,
 BiConsumer<CloudChunk,Throwable> consumer)

Iterate over all chunks that the provider has.

Parameters:

consumer -

Throws:

UnsupportedOperationException - if the provider does not support chunk iteration.

loadLevelData

CompletableFuture<LoadState> loadLevelData(LevelData levelData)

Load level data into given LevelData object

Parameters:

levelData - levelData to load

Returns:

future of loaded level data

saveLevelData

CompletableFuture<Void> saveLevelData(LevelData levelData)

Save level data from given LevelData object

Parameters:

levelData - levelData to save