Package net.minecraft.world.item

Class InstrumentItem

java.lang.Object

net.minecraft.world.item.Item

net.minecraft.world.item.InstrumentItem

All Implemented Interfaces:

FeatureElement, ItemLike, IItemExtension

public class InstrumentItem
extends Item

Nested Class Summary

Nested classes/interfaces inherited from class net.minecraft.world.item.Item

Item.Properties, Item.TooltipContext

Field Summary

Fields

Modifier and Type	Field	Description
private final TagKey<Instrument>	instruments

Fields inherited from class net.minecraft.world.item.Item

ABSOLUTE_MAX_STACK_SIZE, BASE_ATTACK_DAMAGE_ID, BASE_ATTACK_SPEED_ID, BY_BLOCK, canRepair, DEFAULT_MAX_STACK_SIZE, MAX_BAR_WIDTH

Fields inherited from interface net.minecraft.world.flag.FeatureElement

FILTERED_REGISTRIES

Constructor Summary

Constructors

Constructor	Description
InstrumentItem(Item.Properties pProperties, TagKey<Instrument> pInstruments)

Method Summary

Modifier and Type	Method	Description
void	appendHoverText(ItemStack pStack, Item.TooltipContext pContext, List<Component> pTooltipComponents, TooltipFlag pTooltipFlag)
static ItemStack	create(Item pItem, Holder<Instrument> pInstrument)
private Optional<Holder<Instrument>>	getInstrument(ItemStack pStack)
UseAnim	getUseAnimation(ItemStack pStack)	Returns the action that specifies what animation to play when the item is being used.
int	getUseDuration(ItemStack pStack, LivingEntity pEntity)
private static void	play(Level pLevel, Player pPlayer, Instrument pInstrument)
static void	setRandom(ItemStack pStack, TagKey<Instrument> pInstrumentTag, RandomSource pRandom)
InteractionResultHolder<ItemStack>	use(Level pLevel, Player pPlayer, InteractionHand pUsedHand)	Called to trigger the item's "innate" right click behavior.

Methods inherited from class net.minecraft.world.item.Item

asItem, builtInRegistryHolder, byBlock, byId, canAttackBlock, canFitInsideContainerItems, components, finishUsingItem, getAttackDamageBonus, getBarColor, getBarWidth, getBreakingSound, getCraftingRemainingItem, getDefaultAttributeModifiers, getDefaultInstance, getDefaultMaxStackSize, getDescription, getDescriptionId, getDescriptionId, getDestroySpeed, getDrinkingSound, getEatingSound, getEnchantmentValue, getId, getName, getOrCreateDescriptionId, getPlayerPOVHitResult, getTooltipImage, hasCraftingRemainingItem, hurtEnemy, initializeClient, interactLivingEntity, inventoryTick, isBarVisible, isComplex, isCorrectToolForDrops, isEnchantable, isFoil, isRepairable, isValidRepairItem, mineBlock, modifyDefaultComponentsFrom, onCraftedBy, onCraftedPostProcess, onDestroyed, onUseTick, overrideOtherStackedOnMe, overrideStackedOnOther, postHurtEnemy, releaseUsing, requiredFeatures, toString, useOn, useOnRelease, verifyComponentsAfterLoad

Methods inherited from class java.lang.Object

clone, equals, finalize, getClass, hashCode, notify, notifyAll, wait, wait, wait

Methods inherited from interface net.minecraft.world.flag.FeatureElement

isEnabled

Methods inherited from interface net.neoforged.neoforge.common.extensions.IItemExtension

applyEnchantments, canBeHurtBy, canContinueUsing, canDisableShield, canElytraFly, canEquip, canGrindstoneRepair, canPerformAction, canWalkOnPowderedSnow, createEntity, damageItem, doesSneakBypassUse, elytraFlightTick, getAllEnchantments, getArmorTexture, getBurnTime, getCraftingRemainingItem, getCreatorModId, getDamage, getDefaultAttributeModifiers, getEnchantmentLevel, getEnchantmentValue, getEntityLifespan, getEquipmentSlot, getFoodProperties, getHighlightTip, getMaxDamage, getMaxStackSize, getSweepHitBox, getXpRepairRatio, hasCraftingRemainingItem, hasCustomEntity, isBookEnchantable, isDamageable, isDamaged, isEnderMask, isNotReplaceableByPickAction, isPiglinCurrency, isPrimaryItemFor, makesPiglinsNeutral, onAnimalArmorTick, onDestroyed, onDroppedByPlayer, onEntityItemUpdate, onEntitySwing, onEntitySwing, onItemUseFirst, onLeftClickEntity, onStopUsing, setDamage, shouldCauseBlockBreakReset, shouldCauseReequipAnimation, supportsEnchantment

Field Details

instruments

private final TagKey<Instrument> instruments

Constructor Details

InstrumentItem

public InstrumentItem(Item.Properties pProperties,
 TagKey<Instrument> pInstruments)

Method Details

appendHoverText

public void appendHoverText(ItemStack pStack,
 Item.TooltipContext pContext,
 List<Component> pTooltipComponents,
 TooltipFlag pTooltipFlag)

Overrides:

appendHoverText in class Item

create

public static ItemStack create(Item pItem,
 Holder<Instrument> pInstrument)

setRandom

public static void setRandom(ItemStack pStack,
 TagKey<Instrument> pInstrumentTag,
 RandomSource pRandom)

use

public InteractionResultHolder<ItemStack> use(Level pLevel,
 Player pPlayer,
 InteractionHand pUsedHand)

Called to trigger the item's "innate" right click behavior. To handle when this item is used on a Block, see Item.useOn(net.minecraft.world.item.context.UseOnContext).

Overrides:

use in class Item

getUseDuration

public int getUseDuration(ItemStack pStack,
 LivingEntity pEntity)

Overrides:

getUseDuration in class Item

getInstrument

private Optional<Holder<Instrument>> getInstrument(ItemStack pStack)

getUseAnimation

public UseAnim getUseAnimation(ItemStack pStack)

Returns the action that specifies what animation to play when the item is being used.

Overrides:

getUseAnimation in class Item

play

private static void play(Level pLevel,
 Player pPlayer,
 Instrument pInstrument)