mirror of https://github.com/Minestom/Minestom.git
37 lines
1.2 KiB
Java
37 lines
1.2 KiB
Java
package net.minestom.server.instance;
|
|
|
|
import net.minestom.server.instance.batch.ChunkBatch;
|
|
import net.minestom.server.instance.block.Block;
|
|
import org.jetbrains.annotations.NotNull;
|
|
import org.jetbrains.annotations.Nullable;
|
|
|
|
import java.util.List;
|
|
|
|
/**
|
|
* Responsible for the {@link Chunk} generation, can be set using {@link Instance#setChunkGenerator(ChunkGenerator)}.
|
|
* <p>
|
|
* Called if the instance {@link IChunkLoader} hasn't been able to load the chunk.
|
|
*/
|
|
public interface ChunkGenerator {
|
|
|
|
/**
|
|
* Called when the blocks in the {@link Chunk} should be set using {@link ChunkBatch#setBlock(int, int, int, Block)}
|
|
* or similar.
|
|
* <p>
|
|
* WARNING: all positions are chunk-based (0-15).
|
|
*
|
|
* @param batch the {@link ChunkBatch} which will be flush after the generation
|
|
* @param chunkX the chunk X
|
|
* @param chunkZ the chunk Z
|
|
*/
|
|
void generateChunkData(@NotNull ChunkBatch batch, int chunkX, int chunkZ);
|
|
|
|
/**
|
|
* Gets all the {@link ChunkPopulator} of this generator.
|
|
*
|
|
* @return a {@link List} of {@link ChunkPopulator}, can be null or empty
|
|
*/
|
|
@Nullable
|
|
List<ChunkPopulator> getPopulators();
|
|
}
|