net.minecraft.item

Class PotionItem

java.lang.Object

net.minecraft.item.Item

net.minecraft.item.PotionItem

All Implemented Interfaces:

ItemConvertible

Direct Known Subclasses:

ThrowablePotionItem

public class PotionItem
extends Item

Nested Class Summary

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

Item.Settings

Field Summary

Fields inherited from class net.minecraft.item.Item

ATTACK_DAMAGE_MODIFIER_ID, ATTACK_SPEED_MODIFIER_ID, BLOCK_ITEMS, group, RANDOM

Constructor Summary

Constructors

Constructor and Description
PotionItem(Item.Settings settings)

Method Summary

Modifier and Type	Method and Description
void	appendStacks(ItemGroup group, DefaultedList<ItemStack> stacks)
void	appendTooltip(ItemStack stack, World world, List<Text> tooltip, TooltipContext context)
ItemStack	finishUsing(ItemStack stack, World world, LivingEntity user)
ItemStack	getDefaultStack()
int	getMaxUseTime(ItemStack stack)
String	getTranslationKey(ItemStack stack) Gets the translation key of this item using the provided item stack for context.
UseAction	getUseAction(ItemStack stack)
boolean	hasGlint(ItemStack stack) Checks if the glint effect should be applied when the item is rendered.
TypedActionResult<ItemStack>	use(World world, PlayerEntity user, Hand hand) Called when an item is used by a player.

Methods inherited from class net.minecraft.item.Item

asItem, byRawId, canMine, canRepair, damage, fromBlock, getAttributeModifiers, getDrinkSound, getEatSound, getEnchantability, getFoodComponent, getGroup, getMaxCount, getMaxDamage, getMiningSpeedMultiplier, getName, getName, getOrCreateTranslationKey, getRarity, getRawId, getRecipeRemainder, getTranslationKey, hasRecipeRemainder, inventoryTick, isDamageable, isEffectiveOn, isEnchantable, isFireproof, isFood, isIn, isIn, isNetworkSynced, isUsedOnRelease, onCraft, onStoppedUsing, postHit, postMine, postProcessTag, raycast, shouldSyncTagToClient, toString, usageTick, useOnBlock, useOnEntity

Methods inherited from class java.lang.Object

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

Constructor Detail

PotionItem

public PotionItem(Item.Settings settings)

Method Detail

getDefaultStack

public ItemStack getDefaultStack()

Overrides:

getDefaultStack in class Item

finishUsing

public ItemStack finishUsing(ItemStack stack,
                             World world,
                             LivingEntity user)

Overrides:

finishUsing in class Item

getMaxUseTime

public int getMaxUseTime(ItemStack stack)

Overrides:

getMaxUseTime in class Item

getUseAction

public UseAction getUseAction(ItemStack stack)

Overrides:

getUseAction in class Item

use

public TypedActionResult<ItemStack> use(World world,
                                        PlayerEntity user,
                                        Hand hand)

Called when an item is used by a player. The use action, by default, is bound to the right mouse button.

This method is called on both the logical client and logical server, so take caution when overriding this method. The logical side can be checked using world.isClient().

Overrides:

use in class Item

Parameters:

world - the world the item was used in

user - the player who used the item

hand - the hand used

Returns:

a typed action result that specifies whether using the item was successful. The action result contains the new item stack that the player's hand will be set to.

getTranslationKey

public String getTranslationKey(ItemStack stack)

Gets the translation key of this item using the provided item stack for context.

Overrides:

getTranslationKey in class Item

appendTooltip

@Environment(value=CLIENT)
public void appendTooltip(ItemStack stack,
                                                     @Nullable
                                                     World world,
                                                     List<Text> tooltip,
                                                     TooltipContext context)

Overrides:

appendTooltip in class Item

hasGlint

public boolean hasGlint(ItemStack stack)

Checks if the glint effect should be applied when the item is rendered.

By default, returns true if the item has enchantments.

Overrides:

hasGlint in class Item

appendStacks

public void appendStacks(ItemGroup group,
                         DefaultedList<ItemStack> stacks)

Overrides:

appendStacks in class Item