Struct PalettedContainer

pub struct PalettedContainer<S: PalletedContainerKind> {
    pub bits_per_entry: u8,
    pub palette: Palette<S>,
    pub storage: BitStorage,
}

Fields

bits_per_entry: u8

palette: Palette<S>

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.

Implementations

impl<S: PalletedContainerKind> PalettedContainer<S>

pub fn new() -> Self

pub fn read(buf: &mut Cursor<&[u8]>) -> Result<Self, BufReadError>

pub fn index_from_coords(&self, pos: S::SectionPos) -> usize

Calculates the index of the given coordinates.

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

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

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, pos: S::SectionPos) -> S

Returns the value at the given coordinates.

pub fn get_and_set(&mut self, pos: S::SectionPos, value: S) -> S

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

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

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

pub fn set(&mut self, pos: S::SectionPos, value: S)

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

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

Trait Implementations

impl<S: PalletedContainerKind> AzaleaWrite for PalettedContainer<S>

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

impl<S: Clone + PalletedContainerKind> Clone for PalettedContainer<S>

fn clone(&self) -> PalettedContainer<S>

Returns a duplicate of the value.

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

Performs copy-assignment from source.

impl<S: Debug + PalletedContainerKind> Debug for PalettedContainer<S>

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

Formats the value using the given formatter.

impl<S: PalletedContainerKind> Default for PalettedContainer<S>

fn default() -> Self

Returns the “default value” for a type.