FinalizedState: Load and store FinalizedState data

In rbedrock: Analysis and Manipulation of Data from Minecraft Bedrock Edition

Load and store FinalizedState data

Description

FinalizedState data (tag 54) holds a number which indicates a chunk's state of generation.

get_finalized_state_data() and get_finalized_state_value() load FinalizedState data from db. get_finalized_state_data() will silently drop and keys not representing FinalizedState data. get_finalized_state_value() supports loading only a single value. get_finalized_state_values() is a synonym for get_finalized_state_data().

put_finalized_state_data(), put_finalized_state_values(), and put_finalized_state_value() store FinalizedState data into a bedrockdb.

read_finalized_state_value() parses a binary FinalizedState record.

write_finalized_state_value() converts a FinalizedState value to a raw vector.

Usage

get_finalized_state_data(db, x, z, dimension)

get_finalized_state_values(db, x, z, dimension)

get_finalized_state_value(db, x, z, dimension)

put_finalized_state_data(db, data)

put_finalized_state_values(db, x, z, dimension, values)

put_finalized_state_value(db, x, z, dimension, value)

read_finalized_state_value(rawdata)

write_finalized_state_value(value)

Arguments

db	A bedrockdb object.
x, z, dimension	Chunk coordinates to extract data from. x can also be a character vector of db keys.
data	A named-vector of key-value pairs for FinalizedState data.
values	An integer vector
value	a scalar integer
rawdata	a raw vector

Details

FinalizedState data contains the following information.

Value	Name	Description
0	NeedsInstaticking	Chunk needs to be ticked
1	NeedsPopulation	Chunk needs to be populated with mobs
2	Done	Chunk generation is fully complete

Value

get_finalized_state_data() returns a named integer vector of the values returned by get_finalized_state_value().

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