Struct BlockItem 

pub struct BlockItem {
    pub block: BlockRef,
}

Behavior for items that place blocks.

Fields

block: BlockRef

The block this item places.

Implementations

impl BlockItem

const PLACE_BLOCK_FLAGS: UpdateFlags = UpdateFlags::UPDATE_ALL_IMMEDIATE

pub const fn new(block: BlockRef) -> Self

Creates a new block item behavior for the given block.

pub(super) fn place_with( &self, context: BlockPlaceContext<'_>, place_block: impl FnOnce(&BlockPlaceContext<'_>, BlockStateId) -> bool, ) -> InteractionResult

pub(super) fn place_with_sound_and_block( &self, context: BlockPlaceContext<'_>, place_block: impl FnOnce(&BlockPlaceContext<'_>, BlockStateId) -> bool, place_sound: SoundEventRef, ) -> InteractionResult

pub(super) fn place_with_policy<'a>( &self, context: BlockPlaceContext<'a>, update_context: impl FnOnce(BlockPlaceContext<'a>) -> Option<BlockPlaceContext<'a>>, survival_check: SurvivalCheck, place_block: impl FnOnce(&BlockPlaceContext<'a>, BlockStateId) -> bool, place_sound: SoundEventRef, get_state_for_placement: impl FnOnce(&BlockPlaceContext<'a>) -> Option<BlockStateId>, ) -> InteractionResult

pub fn place(&self, context: BlockPlaceContext<'_>) -> InteractionResult

Places this block using an already constructed placement context.

fn update_block_entity_components( context: &BlockPlaceContext<'_>, pos: BlockPos, )

pub(super) fn place_block( context: &BlockPlaceContext<'_>, state: BlockStateId, ) -> bool

pub(super) fn get_state_for_placement( &self, context: &BlockPlaceContext<'_>, ) -> Option<BlockStateId>

Trait Implementations

impl ItemBehavior for BlockItem

fn use_on(&self, context: &mut UseOnContext<'_>) -> InteractionResult

Called when this item is used on a block.

fn can_fit_inside_container_items(&self) -> bool

Whether this item may be stored inside container items such as shulker boxes and bundles, which vanilla uses to stop them nesting.

fn type_name(&self) -> &'static str

Returns the Rust type name of the concrete behavior implementation.

fn get_name<'a>(&self, stack: &'a ItemStack) -> Cow<'a, TextComponent>

Returns this item’s display name, from the stack’s item_name component if present.

fn get_default_instance(&self, item: ItemRef) -> ItemStack

Returns the canonical single-item stack for this item, including component defaults.

fn use_item(&self, context: &mut UseItemContext<'_>) -> InteractionResult

Called when this item is used (e.g. right click in air).

fn get_use_animation(&self, stack: &ItemStack) -> ItemUseAnimation

Returns which animation plays while this item is actively being used, based on its data components.

fn get_use_duration(&self, stack: &ItemStack, _user: &dyn LivingEntity) -> i32

Returns how many ticks this item can be held in active use before it finishes automatically.

fn on_use_tick( &self, _world: &Arc<World>, user: LivingEntityRef<'_>, stack: &mut ItemStack, ticks_remaining: i32, )

Called every tick while a living entity is actively using this item.

fn release_using( &self, _stack: &mut ItemStack, _world: &Arc<World>, _user: &dyn LivingEntity, _time_left: i32, ) -> bool

Called when active use is released before completion.

fn use_on_release(&self, _stack: &ItemStack) -> bool

Returns whether the item acts when the use key is released, rather than the use timer expiring

fn finish_using( &self, stack: &mut ItemStack, world: &Arc<World>, user: LivingEntityRef<'_>, ) -> ItemStack

Called when active use reaches its full duration.

fn interact_living_entity( &self, _stack: &mut ItemStack, _player: &Player, _target: &dyn LivingEntity, _hand: InteractionHand, ) -> InteractionResult

Called when this item is used to interact with a living entity (e.g. right-clicking a mob while holding it).

fn get_item_damage_source( &self, _attacker: &SharedEntity, ) -> Option<DamageSource>

Returns a custom damage source this item should inflict when its wielder attacks, overriding the caller’s default attack damage type.

fn get_attack_damage_bonus( &self, _attacker: &dyn LivingEntity, _victim: &dyn Entity, _base_damage: f32, _damage_source: &DamageSource, ) -> f32

Returns item-specific attack damage added by Item.getAttackDamageBonus.

fn hurt_enemy( &self, _stack: &mut ItemStack, _target: &dyn LivingEntity, _attacker: &dyn LivingEntity, )

Called immediately when this item’s wielder deals a successful melee hit, before post-attack enchantment effects and durability loss.

fn post_hurt_enemy( &self, _stack: &mut ItemStack, _target: &dyn LivingEntity, _attacker: &dyn LivingEntity, )

Called after hurt_enemy and post-attack enchantment effects, right before the item takes durability damage from the hit.

fn inventory_tick(&self, _context: &mut InventoryTickContext<'_>)

Called every tick for each carried item.

fn item_damage_per_attack(&self, stack: &ItemStack) -> Option<i32>

Returns how much durability this weapon consumes after a successful entity hit.

fn as_spawn_egg(&self) -> Option<&SpawnEggItem>

Returns this item behavior as a SpawnEggItem.

fn as_sign_applicator(&self) -> Option<&dyn SignApplicator>

Returns the capability used by sign block interactions.