Struct BlockState 

pub struct BlockState { /* private fields */ }

Represent a particular state of a block, this block state also know all its neighbors by their properties and values.

To build states, use BlockStateContainerBuilder and add all wanted properties.

Implementations

impl BlockState

pub fn get_index(&self) -> u16

pub fn get_key(&'static self) -> BlockStateKey

pub fn get_block(&self) -> &'static Block

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

pub fn get<T, P>(&self, property: &P) -> Option<T>

where T: PropertySerializable, P: Property<T>,

Get a block state property value if the property exists.

pub fn expect<T, P>(&self, property: &P) -> T

where T: PropertySerializable, P: Property<T>,

pub fn with<T, P>(&self, property: &P, value: T) -> Option<&BlockState>

where T: PropertySerializable, P: Property<T>,

Try to get a neighbor with all the same properties excepts the given one with the given value, if the property or its value is not valid for the block, None is returned.

pub fn with_raw(&self, prop_name: &str, prop_value: &str) -> Option<&BlockState>

Try to get a neighbor with all the same properties excepts the given one with the given value, if the property or its value is not valid for the block, None is returned.

This version of with method take raw property name and value as strings.

pub fn iter_raw_states<'a>( &'a self, ) -> Option<impl Iterator<Item = (&'static str, String)> + 'a>

Iterate over representations of each property of this state. No iterator is returned if the underlying block as no other state other than this one.

Trait Implementations

impl Debug for BlockState

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

Formats the value using the given formatter.

impl PartialEq for &'static BlockState

fn eq(&self, other: &Self) -> bool

Tests for self and other values to be equal, and is used by ==.

fn ne(&self, other: &Rhs) -> bool

Tests for !=. The default implementation is almost always sufficient, and should not be overridden without very good reason.

impl Eq for &'static BlockState

impl Send for BlockState

impl Sync for BlockState