Struct GlobalBlocks 

pub struct GlobalBlocks { /* private fields */ }

This is a global blocks palette, it is used in chunk storage to store block states. It allows you to register individual blocks in it as well as static blocks arrays defined using the macro blocks!.

Implementations

impl GlobalBlocks

pub fn new() -> Self

pub fn with_all(slice: &[&'static Block]) -> Result<Self, ()>

A simple constructor to directly call register_all with given blocks slice.

pub fn register(&mut self, block: &'static Block) -> Result<(), ()>

Register a single block to this palette, returns Err if no more save ID (SID) is available, Ok is returned if successful, if a block was already in the palette it also returns Ok.

pub fn register_all(&mut self, slice: &[&'static Block]) -> Result<(), ()>

An optimized way to call register multiple times for each given block, the returned follow the same rules as register, if an error happens, it return without and previous added blocks are kept.

pub fn get_sid_from(&self, state: &'static BlockState) -> Option<u32>

Get the save ID from the given state.

pub fn get_state_from(&self, sid: u32) -> Option<&'static BlockState>

Get the block state from the given save ID.

pub fn get_block_from_name(&self, name: &str) -> Option<&'static Block>

Get the default state from the given block name.

pub fn has_block(&self, block: &'static Block) -> bool

Return true if the palette contains the given block.

pub fn has_state(&self, state: &'static BlockState) -> bool

Return true if the palette contains the given block state.

pub fn check_state<E>( &self, state: &'static BlockState, err: impl FnOnce() -> E, ) -> Result<&'static BlockState, E>

Check if the given state is registered in this palette, Ok is returned if true, in the other case Err is returned with the error created by the given err closure.

pub fn register_tag_type(&mut self, tag_type: &'static TagType)

Register a tag type that will be later possible to set to blocks.

pub fn set_blocks_tag<I>( &mut self, tag_type: &'static TagType, enabled: bool, blocks: I, ) -> Result<(), ()>

where I: IntoIterator<Item = &'static Block>,

Set or unset a tag to some blocks.

pub fn has_block_tag( &self, block: &'static Block, tag_type: &'static TagType, ) -> bool

Get the tag state on specific block, returning false if unknown block or tag type.

pub fn blocks_count(&self) -> usize

pub fn states_count(&self) -> usize

pub fn tags_count(&self) -> usize