Document GenerationUnit size guarantee

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

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
*/ */