Package net.minecraft.world.item

Class PotionItem

java.lang.Object

net.minecraft.world.item.Item

net.minecraft.world.item.PotionItem

All Implemented Interfaces:

FeatureElement, ItemLike, IItemExtension

Direct Known Subclasses:

ThrowablePotionItem

public class PotionItem
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 static final int	DRINK_DURATION

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
PotionItem(Item.Properties pProperties)

Method Summary

Modifier and Type	Method	Description
void	appendHoverText(ItemStack pStack, Item.TooltipContext pContext, List<Component> pTooltipComponents, TooltipFlag pTooltipFlag)
ItemStack	finishUsingItem(ItemStack pStack, Level pLevel, LivingEntity pEntityLiving)	Called when the player finishes using this Item (E.g. finishes eating.).
ItemStack	getDefaultInstance()
String	getDescriptionId(ItemStack pStack)	Returns the unlocalized name of this item.
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)
InteractionResultHolder<ItemStack>	use(Level pLevel, Player pPlayer, InteractionHand pHand)	Called to trigger the item's "innate" right click behavior.
InteractionResult	useOn(UseOnContext pContext)	Called when this item is used when targeting a Block

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

asItem, builtInRegistryHolder, byBlock, byId, canAttackBlock, canFitInsideContainerItems, components, getAttackDamageBonus, getBarColor, getBarWidth, getBreakingSound, getCraftingRemainingItem, getDefaultAttributeModifiers, getDefaultMaxStackSize, getDescription, 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, 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

DRINK_DURATION

private static final int DRINK_DURATION

See Also:

• Constant Field Values

Constructor Details

PotionItem

public PotionItem(Item.Properties pProperties)

Method Details

getDefaultInstance

public ItemStack getDefaultInstance()

Overrides:

getDefaultInstance in class Item

finishUsingItem

public ItemStack finishUsingItem(ItemStack pStack,
 Level pLevel,
 LivingEntity pEntityLiving)

Called when the player finishes using this Item (E.g. finishes eating.). Not called when the player stops using the Item before the action is complete.

Overrides:

finishUsingItem in class Item

useOn

public InteractionResult useOn(UseOnContext pContext)

Called when this item is used when targeting a Block

Overrides:

useOn in class Item

getUseDuration

public int getUseDuration(ItemStack pStack,
 LivingEntity pEntity)

Overrides:

getUseDuration in class Item

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

use

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

Called to trigger the item's "innate" right click behavior. To handle when this item is used on a Block, see

invalid reference

#onItemUse

.

Overrides:

use in class Item

getDescriptionId

public String getDescriptionId(ItemStack pStack)

Returns the unlocalized name of this item. This version accepts an ItemStack so different stacks can have different names based on their damage or NBT.

Overrides:

getDescriptionId in class Item

appendHoverText

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

Overrides:

appendHoverText in class Item