RegionFile

class RegionFile @JvmOverloads() constructor(dataSource: DataSource, regionX: Int, regionZ: Int, minY: Int, maxY: Int) : Closeable

Constructs a Region linked to the given file. Will initialize file contents if the file is not big enough. That means it is valid to pass a newly created and empty file to this constructor, and RegionFile will start filling it.

The RandomAccessFile is ALWAYS sought to the beginning of the file during construction.

Code based on Mojang source code also based on the Minecraft Wiki "Region File format page"

Constructors

RegionFile

@JvmOverloads()

fun RegionFile(file: RandomAccessFile, regionX: Int, regionZ: Int, minY: Int = VanillaMinY, maxY: Int = VanillaMaxY)

RegionFile

@JvmOverloads()

fun RegionFile(dataSource: DataSource, regionX: Int, regionZ: Int, minY: Int = VanillaMinY, maxY: Int = VanillaMaxY)

Types

Companion

object Companion

Functions

open override fun close()

Closes the given RandomAccessFile, and clears the column cache at the same time.

flushCachedChunks

fun flushCachedChunks()

Writes all cached chunks to the disk, empties the cache.

forget

fun forget(column: ChunkColumn)

Unloads from memory the given column.

getBiome

fun getBiome(x: Int, y: Int, z: Int): String

Returns the biome present at the given position.

getBlockState

fun getBlockState(x: Int, y: Int, z: Int): BlockState

Returns the block state present at the given position.

getChunk

fun getChunk(x: Int, z: Int): ChunkColumn?

Gets the chunk inside this RegionFile.

getChunkData

fun getChunkData(x: Int, z: Int): NBTCompound?

Gets the NBT representation of the chunk inside this RegionFile.

getOrCreateChunk

fun getOrCreateChunk(x: Int, z: Int): ChunkColumn

Gets the chunk inside this RegionFile.

hasChunk

fun hasChunk(x: Int, z: Int): Boolean

Does this file contain the given chunk column?

hasLoadedChunk

fun hasLoadedChunk(x: Int, z: Int): Boolean

Does this region contain the given chunk column?

setBiome

fun setBiome(x: Int, y: Int, z: Int, biomeID: String)

Sets the biome at the given position.

setBlockState

fun setBlockState(x: Int, y: Int, z: Int, blockState: BlockState)

Sets the block state at the given position.

writeColumn

@JvmOverloads()

fun writeColumn(column: ChunkColumn, version: SupportedVersion = SupportedVersion.Latest)

Writes a column to the file.

Properties

dataSource

val dataSource: DataSource

logicalHeight

val logicalHeight: Int

maxY

val maxY: Int

minY

val minY: Int

regionX

val regionX: Int

regionZ

val regionZ: Int