Biomes {rbedrock}

Read and write biomes data.

Description

Biomes data is stored as the second map in Data3D data (tag 43). Legacy Biomes data is stored as the second map in the Data2D data (tag 45).

get_biomes_data() and get_biomes_value() load Biomes data from db. get_biomes_data() will silently drop keys not representing Data3D data. get_biomes_value() supports loading only a single value. get_biomes_values() is a synonym for get_biomes_data().

put_biomes_data() put_biomes_values(), and put_biomes_value() update the biome information of chunks. They preserve any existing height data.

⁠get_legacy_biomes_*()⁠ and ⁠put_legacy_biomes_*()⁠ behave similar to the equivalent non-legacy functions. They get or put 2d biome data.

Usage

get_biomes_data(db, x, z, dimension, return_names = TRUE)

get_biomes_values(db, x, z, dimension, return_names = TRUE)

get_biomes_value(db, x, z, dimension, return_names = TRUE)

put_biomes_data(db, data, missing_height = -64L)

put_biomes_values(db, x, z, dimension, values, missing_height = -64L)

put_biomes_value(db, x, z, dimension, value, missing_height = -64L)

get_legacy_biomes_data(db, x, z, dimension, return_names = TRUE)

get_legacy_biomes_values(db, x, z, dimension, return_names = TRUE)

get_legacy_biomes_value(db, x, z, dimension, return_names = TRUE)

put_legacy_biomes_data(db, data, missing_height = 0L)

put_legacy_biomes_values(db, x, z, dimension, values, missing_height = 0L)

put_legacy_biomes_value(db, x, z, dimension, value, missing_height = 0L)

Arguments

db

A bedrockdb object.

x, z, dimension

Chunk coordinates to extract data from. x can also be a character vector of db keys.

return_names

return biome names instead of biome ids.

data

A list of character or integer vectors.

missing_height

if there is no existing height data, use this value for the chunk.

values

a list of arrays containing biome names or ids.

value

an array containing biome names or ids.

Value

get_biomes_value() returns an array with 3 dimensions. get_biomes_data() returns a list of the of the values returned by get_biomes_value().