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

Document GenerationUnit size guarantee

Browse Source 
Signed-off-by: TheMode <themode@outlook.fr>
This commit is contained in:
TheMode 2022-04-11 21:12:58 +02:00
parent 2cea7ca5af
commit 5812482922
1 changed files with 8 additions and 1 deletions

9
src/main/java/net/minestom/server/instance/generator/GenerationUnit.java
View File

@ -7,6 +7,11 @@ import org.jetbrains.annotations.NotNull;
import java.util.List; import java.util.List;
import java.util.function.Consumer; import java.util.function.Consumer;
/**
* Represents an area that can be generated.
* <p>
* The size is guaranteed to be a multiple of 16 (section).
*/
public interface GenerationUnit { public interface GenerationUnit {
/** /**
* This unit's modifier, used to place blocks and biomes within this unit. * This unit's modifier, used to place blocks and biomes within this unit.
@ -17,6 +22,8 @@ public interface GenerationUnit {
/** /**
* The size of this unit in blocks. * The size of this unit in blocks.
* <p>
* Guaranteed to be a multiple of 16.
* *
* @return the size of this unit * @return the size of this unit
*/ */
@ -40,7 +47,7 @@ public interface GenerationUnit {
* Creates a fork of this unit, which will be applied to the instance whenever possible. * Creates a fork of this unit, which will be applied to the instance whenever possible.
* *
* @param start the start of the fork * @param start the start of the fork
* @param end the end of the fork * @param end the end of the fork
* @return the fork * @return the fork
*/ */
@NotNull GenerationUnit fork(@NotNull Point start, @NotNull Point end); @NotNull GenerationUnit fork(@NotNull Point start, @NotNull Point end);