RandomTicks: Load and store RandomTicks NBT data

RandomTicksR Documentation

Load and store RandomTicks NBT data

Description

RandomTicks data (tag 59) holds a list of NBT values for random ticks.

get_random_ticks_data() and get_random_ticks_value() load RandomTicks data from db. get_random_ticks_data() will silently drop and keys not representing RandomTicks data. get_random_ticks_value() supports loading only a single value. get_random_ticks_values() is a synonym for get_random_ticks_data().

put_random_ticks_values(), put_random_ticks_value(), and put_random_ticks_data() store RandomTicks data into db.

Usage

get_random_ticks_data(db, x, z, dimension)

get_random_ticks_values(db, x, z, dimension)

get_random_ticks_value(db, x, z, dimension)

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

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

put_random_ticks_data(db, data)

Arguments

db

A bedrockdb object.

x, z, dimension

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

values

A list of nbt objects

value

An nbt object.

data

A named-list specifying key-value pairs.

Value

get_random_ticks_data() returns a named-list of nbt data. get_random_ticks_values() returns a single nbt value.


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