Struct PalettedContainer

pub struct PalettedContainer {
    pub bits_per_entry: u8,
    pub palette: Palette,
    pub storage: BitStorage,
    pub container_type: PalettedContainerKind,
}

Fields

bits_per_entry: u8

palette: Palette

This is usually a list of unique values that appear in the container so they can be indexed by the bit storage.

Sometimes it doesn’t contain anything if there’s too many unique items in the bit storage, though.

storage: BitStorage

Compacted list of indices pointing to entry IDs in the Palette.

container_type: PalettedContainerKind

Implementations

impl PalettedContainer

pub fn new(container_type: PalettedContainerKind) -> Self

pub fn read_with_type( buf: &mut Cursor<&[u8]>, container_type: &'static PalettedContainerKind, ) -> Result<Self, BufReadError>

pub fn index_from_coords(&self, x: usize, y: usize, z: usize) -> usize

Calculates the index of the given coordinates.

pub fn coords_from_index(&self, index: usize) -> (usize, usize, usize)

pub fn get_at_index(&self, index: usize) -> u32

Returns the value at the given index.

Panics

This function panics if the index is greater than or equal to the number of things in the storage. (So for block states, it must be less than 4096).

pub fn get(&self, x: usize, y: usize, z: usize) -> u32

Returns the value at the given coordinates.

pub fn get_and_set(&mut self, x: usize, y: usize, z: usize, value: u32) -> u32

Sets the id at the given coordinates and return the previous id

pub fn set_at_index(&mut self, index: usize, value: u32)

Sets the id at the given index and return the previous id. You probably want .set instead.

pub fn set(&mut self, x: usize, y: usize, z: usize, value: u32)

Sets the id at the given coordinates and return the previous id

pub fn id_for(&mut self, value: u32) -> usize

Trait Implementations

impl Clone for PalettedContainer

fn clone(&self) -> PalettedContainer

Returns a copy of the value.

fn clone_from(&mut self, source: &Self)

Performs copy-assignment from source.

impl Debug for PalettedContainer

fn fmt(&self, f: &mut Formatter<'_>) -> Result

Formats the value using the given formatter.

impl McBufWritable for PalettedContainer

fn write_into(&self, buf: &mut impl Write) -> Result<(), Error>