Upstream/Minestom
1
0
Fork 0
mirror of https://github.com/Minestom/Minestom.git synced 2025-01-03 23:17:48 +01:00
Code Issues Projects Releases Wiki Activity

Made MinestomBasicChunkLoader requires an InstanceContainer to be dynamic and simplify custom chunk implementation

Browse Source
This commit is contained in:
themode 2020-10-10 08:45:26 +02:00
parent b118fc717b
commit c78ee500e8
2 changed files with 32 additions and 24 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

21
src/main/java/net/minestom/server/instance/InstanceContainer.java
View File

@ -75,12 +75,12 @@ public class InstanceContainer extends Instance {
this.storageLocation = storageLocation;
// Set the default chunk loader which use the instance's StorageLocation to save and load chunks
setChunkLoader(new MinestomBasicChunkLoader(storageLocation));
// Set the default chunk supplier using DynamicChunk
setChunkSupplier((instance, biomes, chunkX, chunkZ) -> new DynamicChunk(instance, biomes, chunkX, chunkZ));
// Set the default chunk loader which use the instance's StorageLocation and ChunkSupplier to save and load chunks
setChunkLoader(new MinestomBasicChunkLoader(this));
// Get instance data from the saved data if a StorageLocation is defined
if (storageLocation != null) {
// Retrieve instance data
@ -566,6 +566,10 @@ public class InstanceContainer extends Instance {
* Change which type of {@link Chunk} implementation to use once one needs to be loaded.
* <p>
* Uses {@link DynamicChunk} by default.
* <p>
* WARNING: if you need to save this instance's chunks later,
* the code needs to be predictable for {@link IChunkLoader#loadChunk(Instance, int, int, ChunkCallback)}
* to create the correct type of {@link Chunk}. tl;dr: Need chunk save = no random
*
* @param chunkSupplier the new {@link ChunkSupplier} of this instance, chunks need to be non-null
* @throws NullPointerException if {@code chunkSupplier} is null
@ -575,6 +579,17 @@ public class InstanceContainer extends Instance {
this.chunkSupplier = chunkSupplier;
}
/**
* Get the current {@link ChunkSupplier}.
* <p>
* You shouldn't use it to generate a new chunk, but as a way to view which one is currently in use.
*
* @return the current {@link ChunkSupplier}
*/
public ChunkSupplier getChunkSupplier() {
return chunkSupplier;
}
/**
* Get all the {@link SharedInstance} linked to this container
*

35
src/main/java/net/minestom/server/instance/MinestomBasicChunkLoader.java
View File

@ -8,44 +8,35 @@ import org.slf4j.Logger;
import org.slf4j.LoggerFactory;
/**
* A {@link IChunkLoader} used by default by {@link InstanceContainer}
* which is based on the {@link StorageLocation} associated to it
* A {@link IChunkLoader} used by {@link InstanceContainer}
* which is based on the {@link StorageLocation} and {@link ChunkSupplier} associated to it.
* <p>
* It simply save chunk serialized data from {@link Chunk#getSerializedData()}
* and deserialize it later with {@link Chunk#readChunk(BinaryReader, ChunkCallback)}
* and deserialize it later with {@link Chunk#readChunk(BinaryReader, ChunkCallback)}.
* <p>
* The key used in the {@link StorageLocation} is defined by {@link #getChunkKey(int, int)} and should NOT be changed
* The key used in the {@link StorageLocation} is defined by {@link #getChunkKey(int, int)} and should NOT be changed.
*/
public class MinestomBasicChunkLoader implements IChunkLoader {
private final static Logger LOGGER = LoggerFactory.getLogger(MinestomBasicChunkLoader.class);
private final StorageLocation storageLocation;
private final ChunkSupplier chunkSupplier;
private final InstanceContainer instanceContainer;
/**
* Create an {@link IChunkLoader} which use a {@link StorageLocation}.
* <p>
* The {@link ChunkSupplier} is used to customize which type of {@link Chunk} this loader should use for loading.
* <p>
* WARNING: {@link Chunk} implementations do not have to have the size serializing format, be careful.
* WARNING: {@link Chunk} implementations do not need to have the same serializing format, be careful.
*
* @param storageLocation the {@link StorageLocation}
* @param chunkSupplier the {@link ChunkSupplier} executed when a chunk object needs to be created
* @param instanceContainer the {@link InstanceContainer} linked to this loader
*/
public MinestomBasicChunkLoader(StorageLocation storageLocation, ChunkSupplier chunkSupplier) {
this.storageLocation = storageLocation;
this.chunkSupplier = chunkSupplier;
}
public MinestomBasicChunkLoader(StorageLocation storageLocation) {
this(storageLocation, (instance, biomes, chunkX, chunkZ) ->
new DynamicChunk(instance, biomes, chunkX, chunkZ)
);
public MinestomBasicChunkLoader(InstanceContainer instanceContainer) {
this.instanceContainer = instanceContainer;
}
@Override
public void saveChunk(Chunk chunk, Runnable callback) {
final StorageLocation storageLocation = instanceContainer.getStorageLocation();
if (storageLocation == null) {
callback.run();
LOGGER.warn("No storage location to save chunk!");
@ -75,6 +66,7 @@ public class MinestomBasicChunkLoader implements IChunkLoader {
@Override
public boolean loadChunk(Instance instance, int chunkX, int chunkZ, ChunkCallback callback) {
final StorageLocation storageLocation = instanceContainer.getStorageLocation();
final byte[] bytes = storageLocation == null ? null : storageLocation.get(getChunkKey(chunkX, chunkZ));
if (bytes == null) {
@ -83,8 +75,9 @@ public class MinestomBasicChunkLoader implements IChunkLoader {
} else {
// Found, load from result bytes
BinaryReader reader = new BinaryReader(bytes);
Chunk chunk = chunkSupplier.getChunk(instance, null, chunkX, chunkZ);
// Execute the callback once all blocks are placed (allow for multithreaded implementation)
// Create the chunk object using the instance's ChunkSupplier to support multiple implementations
Chunk chunk = instanceContainer.getChunkSupplier().getChunk(instance, null, chunkX, chunkZ);
// Execute the callback once all blocks are placed (allow for multithreaded implementations)
chunk.readChunk(reader, callback);
return true;
}