Struct Block 

pub struct Block {

    pub key: Identifier,
    pub config: BlockConfig,
    pub properties: &'static [&'static dyn Property],
    pub default_state_offset: u16,
    pub suffocating: StateBooleanData,
    pub redstone_conductor: StateBooleanData,
    pub fluid_state: StateFluidData,
    pub randomly_ticking: StateBooleanData,
    pub light_properties: LightPropertiesFn,
    pub collision_shape: ShapeFn,
    pub support_shape: ShapeFn,
    pub outline_shape: ShapeFn,
    pub occlusion_shape: ShapeFn,
    pub interaction_shape: ShapeFn,
    pub visual_shape: ShapeFn,
    pub shape_offsets: ShapeOffsetFlags,
    pub id: OnceLock<usize>,
}

Fields

key: Identifier

config: BlockConfig

properties: &'static [&'static dyn Property]

default_state_offset: u16

suffocating: StateBooleanData

Vanilla BlockState.isSuffocating values indexed by block-local state offset.

redstone_conductor: StateBooleanData

Vanilla BlockState.isRedstoneConductor values indexed by block-local state offset.

fluid_state: StateFluidData

Vanilla BlockState.getFluidState values indexed by block-local state offset.

randomly_ticking: StateBooleanData

Vanilla BlockState.isRandomlyTicking values indexed by block-local state offset.

light_properties: LightPropertiesFn

Extracted vanilla light properties indexed by block-local state offset.

collision_shape: ShapeFn

Function to get collision shape for a state offset

support_shape: ShapeFn

Function to get block support shape for a state offset

outline_shape: ShapeFn

Function to get outline shape for a state offset

occlusion_shape: ShapeFn

Function to get occlusion shape for a state offset

interaction_shape: ShapeFn

Function to get interaction shape for a state offset

visual_shape: ShapeFn

Function to get visual shape for a state offset

shape_offsets: ShapeOffsetFlags

Shape channels whose extracted boxes are normalized and need positional offset.

id: OnceLock<usize>

Cached registry ID, set during registration for O(1) lookup on hot paths.

Implementations

impl Block

pub const fn new( key: Identifier, config: BlockConfig, properties: &'static [&'static dyn Property], ) -> Self

pub const fn with_shapes( self, collision: ShapeFn, support: ShapeFn, outline: ShapeFn, occlusion: ShapeFn, interaction: ShapeFn, visual: ShapeFn, ) -> Self

Sets the shape functions for this block.

pub const fn with_suffocating(self, suffocating: StateBooleanData) -> Self

Sets the extracted vanilla BlockState.isSuffocating values for this block.

pub const fn with_redstone_conductor( self, redstone_conductor: StateBooleanData, ) -> Self

Sets the extracted per-state redstone-conductor predicate.

pub const fn with_fluid_state(self, fluid_state: StateFluidData) -> Self

Sets the extracted per-state fluid values.

pub const fn with_randomly_ticking( self, randomly_ticking: StateBooleanData, ) -> Self

Sets the extracted per-state random-tick predicate.

pub const fn with_light_properties( self, light_properties: LightPropertiesFn, ) -> Self

Sets the extracted vanilla light properties for this block.

pub const fn with_shape_offsets(self, offsets: ShapeOffsetFlags) -> Self

Sets which shape channels use the block state’s positional offset.

pub fn get_collision_shape(&self, offset: u16) -> VoxelShape

Gets the collision shape for a given state offset.

pub fn get_support_shape(&self, offset: u16) -> VoxelShape

Gets the block support shape for a given state offset.

pub fn get_outline_shape(&self, offset: u16) -> VoxelShape

Gets the outline shape for a given state offset.

pub fn get_occlusion_shape(&self, offset: u16) -> VoxelShape

Gets the occlusion shape for a given state offset.

pub fn get_interaction_shape(&self, offset: u16) -> VoxelShape

Gets the interaction shape for a given state offset.

pub fn get_visual_shape(&self, offset: u16) -> VoxelShape

Gets the visual shape for a given state offset.

pub fn get_light_properties(&self, offset: u16) -> BlockLightProperties

pub fn get_ticking_metadata(&self, offset: u16) -> BlockStateTickingMetadata

pub fn offset_at(&self, pos: BlockPos) -> DVec3

Returns the vanilla block-state positional offset for this block.

pub(crate) const fn with_default_state(self, offset: u16) -> Self

Sets the default state offset for this block. The offset is relative to the block’s base state ID.

For easier usage, consider using with_default_state_from_indices or the default_state! macro instead of calculating the offset manually.

Example

const REPEATER: Block = Block::new("repeater", props, &[...])
    .with_default_state(4);

pub const fn calculate_offset( property_indices: &[usize], property_counts: &[usize], ) -> u16

Const helper to calculate state offset from property indices and counts. Properties are processed in reverse order to match Minecraft’s encoding (last property = inner loop with multiplier 1).

pub fn default_state(&'static self) -> BlockStateId

pub fn state_count(&self) -> u16

Total number of distinct states (the product of every property’s value count).

pub fn has_tag(&'static self, tag: &Identifier) -> bool

Returns true if this block is tagged with the given tag.

Trait Implementations

impl Debug for Block

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

Formats the value using the given formatter.

impl Eq for Block

impl PartialEq for Block

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

Equality operator ==.

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

Inequality operator !=.

impl RegistryEntry for Block

fn key(&self) -> &Identifier

fn try_id(&self) -> Option<usize>

fn id(&self) -> usize

Panics

impl RegistryHolderSetEntry for Block

const REGISTRY_NAME: &'static str = "block"

Human-readable registry name used in codec errors.

fn holder_set_by_id(id: usize) -> Option<&'static Self>

Looks up an entry by its protocol registry ID.

fn holder_set_by_key(key: &Identifier) -> Option<&'static Self>

Looks up an entry by its registry key.

fn holder_set_tag_exists(tag: &Identifier) -> bool

Returns whether the registry contains this tag.

fn holder_set_tag_contains(entry: &'static Self, tag: &Identifier) -> bool

Returns whether an entry belongs to this tag.