Struct LeadItem 

pub struct LeadItem;

Vanilla lead item behavior.

The behavior does not handle the main functionality of a lead, but rather its block use functionality: right-clicking a fence removes the knot from the user and places a knot at the right-clicked fence for all entities (Leashables) leashed by the user.

Implementations

impl LeadItem

pub fn bind_player_mobs( player: &Player, world: &Arc<World>, pos: BlockPos, ) -> InteractionResult

Binds all leashable mobs attached to a player to the block with the provided position.

Trait Implementations

impl ItemBehavior for LeadItem

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

Called when this item is used on a block.

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 vanilla Item.getName(stack).

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 vanilla Item.getUseAnimation.

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

Returns vanilla Item.getUseDuration.

fn on_use_tick( &self, _world: &Arc<World>, user: &dyn LivingEntity, 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: &dyn LivingEntity, ) -> 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 by vanilla ItemStack.interactLivingEntity.

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

Returns vanilla Item.getItemDamageSource.

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 by vanilla Item.hurtEnemy.

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

Called by vanilla Item.postHurtEnemy.

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

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

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 as_spawn_egg(&self) -> Option<&SpawnEggItem>

Returns this item behavior as a SpawnEggItem.