ChunkReader

class ChunkReader constructor(chunkData: NBTCompound)

Extracts chunk data from a NBTCompound. Does not cache nor convert the raw data. Use when you want to read parts of a chunk without having the memory overhead of ChunkColumn.

Only two piece of information are cached with this object: the data version of the chunk, which is used to know how to extract the chunk data, and the input NBT.

Can throw AnvilException if the NBT data is not recognized or incomplete.

For information on what the different fields extracted from the NBT are, see Chunk Format on the Minecraft wiki

Constructors

ChunkReader

fun ChunkReader(chunkData: NBTCompound)

Functions

getAirCarvingMask

fun getAirCarvingMask(): ImmutableByteArray?

Can return null if none found.

getBlockEntities

fun getBlockEntities(): NBTList<NBTCompound>

getCarvingMasks

fun getCarvingMasks(): NBTCompound?

Can return null if none found.

getChunkX

fun getChunkX(): Int

getChunkZ

fun getChunkZ(): Int

getDataVersion

fun getDataVersion(): Int

Returns the data version of the input chunk

getGenerationStatus

fun getGenerationStatus(): ChunkColumn.GenerationStatus

getHeightmaps

fun getHeightmaps(): NBTCompound?

Can return null if none found.

getInhabitedTime

fun getInhabitedTime(): Long

getLastUpdate

fun getLastUpdate(): Long

getLights

fun getLights(): NBTList<NBTList<NBTShort>>?

Can return null if none found

getLiquidCarvingMask

fun getLiquidCarvingMask(): ImmutableByteArray?

Can return null if none found.

getLiquidTicks

fun getLiquidTicks(): NBTList<NBTCompound>

getMinecraftVersion

fun getMinecraftVersion(): SupportedVersion

Returns a minimum Minecraft version this chunk might come from.

getMotionBlockingHeightmap

fun getMotionBlockingHeightmap(): ImmutableLongArray?

Can return null if none found.

getMotionBlockingNoLeavesHeightmap

fun getMotionBlockingNoLeavesHeightmap(): ImmutableLongArray?

Can return null if none found.

getOceanFloorHeightmap

fun getOceanFloorHeightmap(): ImmutableLongArray?

Can return null if none found.

getOceanFloorWorldGenHeightmap

fun getOceanFloorWorldGenHeightmap(): ImmutableLongArray?

Can return null if none found.

getOldBiomes

fun getOldBiomes(): ImmutableIntArray?

Can return null if none found.

getOldEntities

fun getOldEntities(): NBTList<NBTCompound>

Older chunks (pre 1.17) store entities inside the region/ *.

getOldLiquidsToBeTicked

fun getOldLiquidsToBeTicked(): NBTList<NBTList<NBTShort>>?

Can return null if none found.

getOldToBeTicked

fun getOldToBeTicked(): NBTList<NBTList<NBTShort>>?

Can return null if none found.

getPostProcessing

fun getPostProcessing(): NBTList<NBTList<NBTShort>>?

Can return null if none found

getSections

fun getSections(): NBTList<NBTCompound>

getStructures

fun getStructures(): NBTCompound?

Can return null if none found

getTileEntities

fun getTileEntities(): NBTList<NBTCompound>

Alternative name for getBlockEntities

getTileTicks

fun getTileTicks(): NBTList<NBTCompound>

getWorldSurfaceHeightmap

fun getWorldSurfaceHeightmap(): ImmutableLongArray?

Can return null if none found.

getWorldSurfaceWorldGenHeightmap

fun getWorldSurfaceWorldGenHeightmap(): ImmutableLongArray?

Can return null if none found.

getYRange

fun getYRange(): IntRange

hasHeightmaps

fun hasHeightmaps(): Boolean

Returns true iif this chunk has heightmap data

isLightOn

fun isLightOn(): Boolean

readSectionBiomes

fun readSectionBiomes(chunkSectionReader: ChunkSectionReader): SectionBiomeInformation?

Can return null if none found.

Properties

chunkData

val chunkData: NBTCompound