Struct BlockState 

pub struct BlockState(/* private fields */);

A 1.16.5 block state (global palette id).

Implementations

impl BlockState

pub const AIR: BlockState

minecraft:air (id 0).

pub const fn from_id(id: u16) -> Option<BlockState>

Wraps a palette id; None if out of range.

pub const fn id(self) -> u16

Palette id.

pub fn block(self) -> Block

The block type.

pub fn is_air(self) -> bool

true for air, cave_air and void_air.

pub fn collision(self) -> Collision

Collision boxes and what else they depend on. Hot path: three table lookups.

pub fn full_cube(self) -> bool

true when the collision shape is exactly a full cube (oracle full_cube).

pub fn solid_block(self) -> bool

AbstractBlockState.isSolidBlock (oracle solid_block).

pub fn should_suffocate(self) -> bool

AbstractBlockState.shouldSuffocate (oracle suffocates).

pub fn voxel_shape(self) -> &'static VoxelShapeRef

The collision VoxelShape (context-free; see BlockState::scaffolding_shapes).

pub fn full_cube_identity(self) -> bool

The collision shape is VoxelShapes.fullCube() (identity, as vanilla’s fast paths test).

pub fn empty_identity(self) -> bool

The collision shape is VoxelShapes.empty() (identity).

pub fn material_liquid(self) -> bool

Material.isLiquid() of the state’s material.

pub fn material_solid(self) -> bool

Material.isSolid() of the state’s material.

pub fn material_replaceable(self) -> bool

Material.isReplaceable() of the state’s material.

pub fn exceeds_cube(self) -> bool

AbstractBlockState.exceedsCube().

pub fn has_dynamic_bounds(self) -> bool

AbstractBlock.dynamicBounds (no shape cache; shapes recomputed per query).

pub fn material_blocks_movement(self) -> bool

Material.blocksMovement() of the state’s material.

pub fn side_solid_full_square(self, side: Side) -> bool

isSideSolidFullSquare(world, pos, side) in an otherwise empty world.

pub fn scaffolding_shapes(self) -> Option<ScaffoldingShapes>

Scaffolding context shapes; None for other blocks.

pub fn shape(self) -> &'static [Aabb]

Collision boxes from the table.

pub fn fluid(self) -> Option<Fluid>

Fluid in this state: water / lava blocks with their level, waterlogged states and always-wet blocks (kelp, seagrass, bubble column) as water level 0.

pub fn get_index(self, prop: Property) -> Option<usize>

Index of prop’s value in PropertyDef::values, if the block has that property.

pub fn get(self, prop: Property) -> Option<&'static str>

The value of prop ("north", "true", "3"), if the block has that property.

pub fn with(self, prop: Property, value: &str) -> Option<BlockState>

This state with prop set to value; None if the block lacks the property or value.

pub fn properties(self) -> impl Iterator<Item = (Property, &'static str)>

(property, value) pairs of this state, most significant property first.

Trait Implementations

impl Clone for BlockState

fn clone(&self) -> Self

Returns a duplicate of the value.

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

Performs copy-assignment from source.

impl Copy for BlockState

impl Debug for BlockState

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

Formats the value using the given formatter.

impl Display for BlockState

minecraft:oak_stairs[facing=north,half=bottom,...], the vanilla block-state string form.

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

Formats the value using the given formatter.

impl Eq for BlockState

impl Hash for BlockState

fn hash<__H: Hasher>(&self, state: &mut __H)

Feeds this value into the given Hasher.

fn hash_slice<H>(data: &[Self], state: &mut H)

where H: Hasher, Self: Sized,

Feeds a slice of this type into the given Hasher.

impl Ord for BlockState

fn cmp(&self, other: &Self) -> Ordering

This method returns an Ordering between self and other.

fn max(self, other: Self) -> Self

where Self: Sized,

Compares and returns the maximum of two values.

fn min(self, other: Self) -> Self

where Self: Sized,

Compares and returns the minimum of two values.

fn clamp(self, min: Self, max: Self) -> Self

where Self: Sized,

Restrict a value to a certain interval.

fn clamp_to<R>(self, range: R) -> Self

where Self: Sized, R: ClampBounds<Self>,

🔬This is a nightly-only experimental API. (clamp_to)

Restrict a value to a certain range.

impl PartialEq for BlockState

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

Equality operator ==.

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

Inequality operator !=.

impl PartialOrd for BlockState

fn partial_cmp(&self, other: &Self) -> Option<Ordering>

This method returns an ordering between self and other values if one exists.

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

Tests less than (for self and other) and is used by the < operator.

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

Tests less than or equal to (for self and other) and is used by the <= operator.

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

Tests greater than (for self and other) and is used by the > operator.

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

Tests greater than or equal to (for self and other) and is used by the >= operator.

impl StructuralPartialEq for BlockState