get_subchunk_layers_data: Load and store SubchunkBlocks layers

View source: R/blocks.R

get_subchunk_layers_dataR Documentation

Load and store SubchunkBlocks layers

Description

get_subchunk_layers_data() loads SubchunkBlocks data from a bedrockdb. It will silently drop and keys not representing SubchunkBlocks data. get_subchunk_layers_values() is a synonym for get_subchunk_layers_data().

get_subchunk_layers_value() loads SubchunkBlocks data from a bedrockdb. It only supports loading a single value.

get_subchunk_layers_value() loads SubchunkBlocks data from a bedrockdb. It supports efficiently loading subchunk block data from a single chunk.

put_subchunk_layers_data(), put_subchunk_layers_values(), and put_subchunk_layers_value() store SubchunkBlocks data into a bedrockdb.

read_subchunk_layers_value() decodes binary SubchunkBlock data into index-mapped arrays and associated block palettes.

write_subchunk_layers_value() encode SubchunkBlock data into binary form.

Usage

get_subchunk_layers_data(db, x, z, dimension, subchunk)

get_subchunk_layers_values(db, x, z, dimension, subchunk)

get_subchunk_layers_value(db, x, z, dimension, subchunk)

get_subchunk_layers_from_chunk(db, x, z, dimension)

put_subchunk_layers_data(db, data, ...)

put_subchunk_layers_values(db, x, z, dimension, subchunk, values, ...)

put_subchunk_layers_value(db, x, z, dimension, subchunk, value, ...)

read_subchunk_layers_value(rawdata)

write_subchunk_layers_value(object, version = 9L, missing_offset = NA_integer_)

Arguments

db

A bedrockdb object.

x, z, dimension

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

subchunk

Subchunk indexes to extract data from.

data

A named-vector of key-value pairs for SubchunkBlocks data.

values

A list of lists of 16x16x16 integer indexes with associated block_palettes.

value

A list of 16x16x16 integer indexes with associated block_palettes.

missing_offset

subchunk offset to use if one is not found in rawdata

Value

get_subchunk_layers_data() returns a list of the of the values returned by read_subchunk_layers_value().

get_subchunk_layers_value() and read_subchunk_layers_value() return a list of block layers. Each block layer is a 16x16x16 array of integers associated with a block palette. The block palette is stored in the "palette" attribute of the array.

get_subchunk_layers_value() returns a list of the of the values returned by read_subchunk_layers_value().


rbedrock documentation built on Oct. 7, 2023, 1:07 a.m.