feat: Add BlockVolume.blockPalette accessor

SpongePowered · May 31, 2024 · 6dbbd37 · 6dbbd37
1 parent fa59da1
commit 6dbbd37
Showing 1 changed file with 11 additions and 0 deletions.
diff --git a/src/main/java/org/spongepowered/api/world/volume/block/BlockVolume.java b/src/main/java/org/spongepowered/api/world/volume/block/BlockVolume.java
@@ -46,6 +46,17 @@
 
 public interface BlockVolume extends Volume {
 
+    /**
+     * Gets the {@link Palette} in use for this particular {@link Volume}.
+     * It is not guaranteed that the palette is the same across smaller
+     * {@link Volume Volumes} that may be contained within this volume.
+     * An example can be the difference between a {@link org.spongepowered.api.world.chunk.Chunk}
+     * and {@link org.spongepowered.api.world.World}'s palette.
+     *
+     * @return The block palette in use for this volume
+     */
+    Palette<BlockState, BlockType> blockPalette();
+
     BlockState block(int x, int y, int z);
 
     default BlockState block(final Vector3i vector3i) {