Package net.minecraft.item

Class BundleItem

java.lang.Object

net.minecraft.item.Item

net.minecraft.item.BundleItem

All Implemented Interfaces:

ItemConvertible, ToggleableFeature

public class BundleItem
extends Item

Mappings:

Namespace	Name
official	cdz
intermediary	net/minecraft/class_5537
named	net/minecraft/item/BundleItem

Nested Class Summary

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

Item.Settings

Field Summary

Fields

Modifier and Type	Field	Description
private static final int	BUNDLE_ITEM_OCCUPANCY
private static final int	ITEM_BAR_COLOR
private static final String	ITEMS_KEY
static final int	MAX_STORAGE

Fields inherited from class net.minecraft.item.Item

ATTACK_DAMAGE_MODIFIER_ID, ATTACK_SPEED_MODIFIER_ID, BLOCK_ITEMS, DEFAULT_MAX_COUNT, DEFAULT_MAX_USE_TIME, ITEM_BAR_STEPS

Fields inherited from interface net.minecraft.resource.featuretoggle.ToggleableFeature

FEATURE_ENABLED_REGISTRY_KEYS

Constructor Summary

Constructors

Constructor	Description
BundleItem(Item.Settings settings)

Method Summary

Modifier and Type	Method	Description
private static int	addToBundle(ItemStack bundle, ItemStack stack)
void	appendTooltip(ItemStack stack, World world, List<Text> tooltip, TooltipContext context)	Called by the client to append tooltips to an item.
private static Optional<NbtCompound>	canMergeStack(ItemStack stack, NbtList items)
private static boolean	dropAllBundledItems(ItemStack stack, PlayerEntity player)
static float	getAmountFilled(ItemStack stack)
private static Stream<ItemStack>	getBundledStacks(ItemStack stack)
private static int	getBundleOccupancy(ItemStack stack)
int	getItemBarColor(ItemStack stack)	Returns the RGB color of the item bar, usually used for durability display.
int	getItemBarStep(ItemStack stack)	Returns the step, or the length of the colored area of the item bar, for stack.
private static int	getItemOccupancy(ItemStack stack)
Optional<TooltipData>	getTooltipData(ItemStack stack)
boolean	isItemBarVisible(ItemStack stack)	Returns whether to show the item bar for stack.
boolean	onClicked(ItemStack stack, ItemStack otherStack, Slot slot, ClickType clickType, PlayerEntity player, StackReference cursorStackReference)	Called when the item at slot gets clicked by the cursor holding otherStack.
void	onItemEntityDestroyed(ItemEntity entity)	Called on the server when an ItemEntity holding this item gets destroyed.
boolean	onStackClicked(ItemStack stack, Slot slot, ClickType clickType, PlayerEntity player)	Called when the item at the cursor is clicked at slot.
private void	playDropContentsSound(Entity entity)
private void	playInsertSound(Entity entity)
private void	playRemoveOneSound(Entity entity)
private static Optional<ItemStack>	removeFirstStack(ItemStack stack)
TypedActionResult<ItemStack>	use(World world, PlayerEntity user, Hand hand)	Called when the player uses (or starts using) the item.

Methods inherited from class net.minecraft.item.Item

asItem, byRawId, canBeNested, canMine, canRepair, damage, finishUsing, fromBlock, getAttributeModifiers, getDefaultStack, getDrinkSound, getEatSound, getEnchantability, getFoodComponent, getMaxCount, getMaxDamage, getMaxUseTime, getMiningSpeedMultiplier, getName, getName, getOrCreateTranslationKey, getRarity, getRawId, getRecipeRemainder, getRegistryEntry, getRequiredFeatures, getTranslationKey, getTranslationKey, getUseAction, hasGlint, hasRecipeRemainder, inventoryTick, isDamageable, isEnchantable, isFireproof, isFood, isNbtSynced, isNetworkSynced, isSuitableFor, isUsedOnRelease, onCraft, onStoppedUsing, postHit, postMine, postProcessNbt, raycast, toString, usageTick, useOnBlock, useOnEntity

Methods inherited from class java.lang.Object

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

Methods inherited from interface net.minecraft.resource.featuretoggle.ToggleableFeature

isEnabled

Field Details

ITEMS_KEY

private static final String ITEMS_KEY

See Also:

• Constant Field Values

Mappings:

Namespace	Name	Mixin selector
official	b	Lcdz;b:Ljava/lang/String;
intermediary	field_30858	Lnet/minecraft/class_5537;field_30858:Ljava/lang/String;
named	ITEMS_KEY	Lnet/minecraft/item/BundleItem;ITEMS_KEY:Ljava/lang/String;

MAX_STORAGE

public static final int MAX_STORAGE

See Also:

• Constant Field Values

Mappings:

Namespace	Name	Mixin selector
official	a	Lcdz;a:I
intermediary	field_30857	Lnet/minecraft/class_5537;field_30857:I
named	MAX_STORAGE	Lnet/minecraft/item/BundleItem;MAX_STORAGE:I

BUNDLE_ITEM_OCCUPANCY

private static final int BUNDLE_ITEM_OCCUPANCY

See Also:

• Constant Field Values

Mappings:

Namespace	Name	Mixin selector
official	c	Lcdz;c:I
intermediary	field_30859	Lnet/minecraft/class_5537;field_30859:I
named	BUNDLE_ITEM_OCCUPANCY	Lnet/minecraft/item/BundleItem;BUNDLE_ITEM_OCCUPANCY:I

ITEM_BAR_COLOR

private static final int ITEM_BAR_COLOR

Mappings:

Namespace	Name	Mixin selector
official	d	Lcdz;d:I
intermediary	field_27016	Lnet/minecraft/class_5537;field_27016:I
named	ITEM_BAR_COLOR	Lnet/minecraft/item/BundleItem;ITEM_BAR_COLOR:I

Constructor Details

BundleItem

public BundleItem(Item.Settings settings)

Mappings:

Namespace	Name	Mixin selector
official	<init>	Lcfs;<init>(Lcfs$a;)V
intermediary	<init>	Lnet/minecraft/class_1792;<init>(Lnet/minecraft/class_1792$class_1793;)V
named	<init>	Lnet/minecraft/item/Item;<init>(Lnet/minecraft/item/Item$Settings;)V

Method Details

getAmountFilled

public static float getAmountFilled(ItemStack stack)

Mappings:

Namespace	Name	Mixin selector
official	d	Lcdz;d(Lcfx;)F
intermediary	method_31561	Lnet/minecraft/class_5537;method_31561(Lnet/minecraft/class_1799;)F
named	getAmountFilled	Lnet/minecraft/item/BundleItem;getAmountFilled(Lnet/minecraft/item/ItemStack;)F

onStackClicked

public boolean onStackClicked(ItemStack stack,
 Slot slot,
 ClickType clickType,
 PlayerEntity player)

Called when the item at the cursor is clicked at slot.

While this method is usually called on the logical server, it can also be called on the logical client, so take caution when overriding this method. The logical side can be checked using World.isClient.

For example, this is called on BundleItem when the cursor holds a bundle and the player clicks on the slot.

Overrides:

onStackClicked in class Item

Parameters:

stack - the stack the cursor holds

slot - the clicked slot

Returns:

whether the action was successful

Mappings:

Namespace	Name	Mixin selector
official	a	Lcfs;a(Lcfx;Lccv;Lcbl;Lbym;)Z
intermediary	method_31565	Lnet/minecraft/class_1792;method_31565(Lnet/minecraft/class_1799;Lnet/minecraft/class_1735;Lnet/minecraft/class_5536;Lnet/minecraft/class_1657;)Z
named	onStackClicked	Lnet/minecraft/item/Item;onStackClicked(Lnet/minecraft/item/ItemStack;Lnet/minecraft/screen/slot/Slot;Lnet/minecraft/util/ClickType;Lnet/minecraft/entity/player/PlayerEntity;)Z

onClicked

public boolean onClicked(ItemStack stack,
 ItemStack otherStack,
 Slot slot,
 ClickType clickType,
 PlayerEntity player,
 StackReference cursorStackReference)

Called when the item at slot gets clicked by the cursor holding otherStack.

While this method is usually called on the logical server, it can also be called on the logical client, so take caution when overriding this method. The logical side can be checked using World.isClient.

For example, this is called on BundleItem when the cursor holds an item and the player clicks on the slot that has a bundle.

Overrides:

onClicked in class Item

Parameters:

stack - the slot's stack

otherStack - the stack the cursor holds

slot - the clicked slot

Returns:

whether the action was successful

Mappings:

Namespace	Name	Mixin selector
official	a	Lcfs;a(Lcfx;Lcfx;Lccv;Lcbl;Lbym;Lbgq;)Z
intermediary	method_31566	Lnet/minecraft/class_1792;method_31566(Lnet/minecraft/class_1799;Lnet/minecraft/class_1799;Lnet/minecraft/class_1735;Lnet/minecraft/class_5536;Lnet/minecraft/class_1657;Lnet/minecraft/class_5630;)Z
named	onClicked	Lnet/minecraft/item/Item;onClicked(Lnet/minecraft/item/ItemStack;Lnet/minecraft/item/ItemStack;Lnet/minecraft/screen/slot/Slot;Lnet/minecraft/util/ClickType;Lnet/minecraft/entity/player/PlayerEntity;Lnet/minecraft/inventory/StackReference;)Z

use

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

Called when the player uses (or starts using) the item. The use action, by default, is bound to the right mouse button. This method checks the player's hunger when the item is a food, and will pass in all other cases by default.

If the item can be used for multiple ticks, then this will only be called when the player starts using it. After that, Item.usageTick(net.minecraft.world.World, net.minecraft.entity.LivingEntity, net.minecraft.item.ItemStack, int) is called every tick until the player finishes using the item.

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.

Mappings:

Namespace	Name	Mixin selector
official	a	Lcfs;a(Lcmk;Lbym;Lbdv;)Lbdx;
intermediary	method_7836	Lnet/minecraft/class_1792;method_7836(Lnet/minecraft/class_1937;Lnet/minecraft/class_1657;Lnet/minecraft/class_1268;)Lnet/minecraft/class_1271;
named	use	Lnet/minecraft/item/Item;use(Lnet/minecraft/world/World;Lnet/minecraft/entity/player/PlayerEntity;Lnet/minecraft/util/Hand;)Lnet/minecraft/util/TypedActionResult;

isItemBarVisible

public boolean isItemBarVisible(ItemStack stack)

Returns whether to show the item bar for stack.

Item bar is usually used to display durability of the stack.

When overriding this, Item.getItemBarStep(net.minecraft.item.ItemStack) and Item.getItemBarColor(net.minecraft.item.ItemStack) should also be overridden.

Overrides:

isItemBarVisible in class Item

Returns:

whether to show the item bar for stack

Mappings:

Namespace	Name	Mixin selector
official	e	Lcfs;e(Lcfx;)Z
intermediary	method_31567	Lnet/minecraft/class_1792;method_31567(Lnet/minecraft/class_1799;)Z
named	isItemBarVisible	Lnet/minecraft/item/Item;isItemBarVisible(Lnet/minecraft/item/ItemStack;)Z

getItemBarStep

public int getItemBarStep(ItemStack stack)

Returns the step, or the length of the colored area of the item bar, for stack.

This is between 0.0f and {code 13.0f}. By default, this is durability * 13.0f / maxDurability.

When overriding this, Item.isItemBarVisible(net.minecraft.item.ItemStack) and Item.getItemBarColor(net.minecraft.item.ItemStack) should also be overridden.

Overrides:

getItemBarStep in class Item

Returns:

the step, or the length of the colored area of the item bar, for stack

Mappings:

Namespace	Name	Mixin selector
official	f	Lcfs;f(Lcfx;)I
intermediary	method_31569	Lnet/minecraft/class_1792;method_31569(Lnet/minecraft/class_1799;)I
named	getItemBarStep	Lnet/minecraft/item/Item;getItemBarStep(Lnet/minecraft/item/ItemStack;)I

getItemBarColor

public int getItemBarColor(ItemStack stack)

Returns the RGB color of the item bar, usually used for durability display.

When overriding this, Item.isItemBarVisible(net.minecraft.item.ItemStack) and Item.getItemBarStep(net.minecraft.item.ItemStack) should also be overridden.

Overrides:

getItemBarColor in class Item

Returns:

the RGB color of the item bar, usually used for durability display

Mappings:

Namespace	Name	Mixin selector
official	g	Lcfs;g(Lcfx;)I
intermediary	method_31571	Lnet/minecraft/class_1792;method_31571(Lnet/minecraft/class_1799;)I
named	getItemBarColor	Lnet/minecraft/item/Item;getItemBarColor(Lnet/minecraft/item/ItemStack;)I

addToBundle

private static int addToBundle(ItemStack bundle,
 ItemStack stack)

Mappings:

Namespace	Name	Mixin selector
official	b	Lcdz;b(Lcfx;Lcfx;)I
intermediary	method_31560	Lnet/minecraft/class_5537;method_31560(Lnet/minecraft/class_1799;Lnet/minecraft/class_1799;)I
named	addToBundle	Lnet/minecraft/item/BundleItem;addToBundle(Lnet/minecraft/item/ItemStack;Lnet/minecraft/item/ItemStack;)I

canMergeStack

private static Optional<NbtCompound> canMergeStack(ItemStack stack,
 NbtList items)

Mappings:

Namespace	Name	Mixin selector
official	a	Lcdz;a(Lcfx;Lqx;)Ljava/util/Optional;
intermediary	method_32344	Lnet/minecraft/class_5537;method_32344(Lnet/minecraft/class_1799;Lnet/minecraft/class_2499;)Ljava/util/Optional;
named	canMergeStack	Lnet/minecraft/item/BundleItem;canMergeStack(Lnet/minecraft/item/ItemStack;Lnet/minecraft/nbt/NbtList;)Ljava/util/Optional;

getItemOccupancy

private static int getItemOccupancy(ItemStack stack)

Mappings:

Namespace	Name	Mixin selector
official	k	Lcdz;k(Lcfx;)I
intermediary	method_31562	Lnet/minecraft/class_5537;method_31562(Lnet/minecraft/class_1799;)I
named	getItemOccupancy	Lnet/minecraft/item/BundleItem;getItemOccupancy(Lnet/minecraft/item/ItemStack;)I

getBundleOccupancy

private static int getBundleOccupancy(ItemStack stack)

Mappings:

Namespace	Name	Mixin selector
official	o	Lcdz;o(Lcfx;)I
intermediary	method_31563	Lnet/minecraft/class_5537;method_31563(Lnet/minecraft/class_1799;)I
named	getBundleOccupancy	Lnet/minecraft/item/BundleItem;getBundleOccupancy(Lnet/minecraft/item/ItemStack;)I

removeFirstStack

private static Optional<ItemStack> removeFirstStack(ItemStack stack)

Mappings:

Namespace	Name	Mixin selector
official	p	Lcdz;p(Lcfx;)Ljava/util/Optional;
intermediary	method_32759	Lnet/minecraft/class_5537;method_32759(Lnet/minecraft/class_1799;)Ljava/util/Optional;
named	removeFirstStack	Lnet/minecraft/item/BundleItem;removeFirstStack(Lnet/minecraft/item/ItemStack;)Ljava/util/Optional;

dropAllBundledItems

private static boolean dropAllBundledItems(ItemStack stack,
 PlayerEntity player)

Mappings:

Namespace	Name	Mixin selector
official	a	Lcdz;a(Lcfx;Lbym;)Z
intermediary	method_32757	Lnet/minecraft/class_5537;method_32757(Lnet/minecraft/class_1799;Lnet/minecraft/class_1657;)Z
named	dropAllBundledItems	Lnet/minecraft/item/BundleItem;dropAllBundledItems(Lnet/minecraft/item/ItemStack;Lnet/minecraft/entity/player/PlayerEntity;)Z

getBundledStacks

private static Stream<ItemStack> getBundledStacks(ItemStack stack)

Mappings:

Namespace	Name	Mixin selector
official	q	Lcdz;q(Lcfx;)Ljava/util/stream/Stream;
intermediary	method_32345	Lnet/minecraft/class_5537;method_32345(Lnet/minecraft/class_1799;)Ljava/util/stream/Stream;
named	getBundledStacks	Lnet/minecraft/item/BundleItem;getBundledStacks(Lnet/minecraft/item/ItemStack;)Ljava/util/stream/Stream;

getTooltipData

public Optional<TooltipData> getTooltipData(ItemStack stack)

Overrides:

getTooltipData in class Item

Mappings:

Namespace	Name	Mixin selector
official	h	Lcfs;h(Lcfx;)Ljava/util/Optional;
intermediary	method_32346	Lnet/minecraft/class_1792;method_32346(Lnet/minecraft/class_1799;)Ljava/util/Optional;
named	getTooltipData	Lnet/minecraft/item/Item;getTooltipData(Lnet/minecraft/item/ItemStack;)Ljava/util/Optional;

appendTooltip

public void appendTooltip(ItemStack stack,
 World world,
 List<Text> tooltip,
 TooltipContext context)

Called by the client to append tooltips to an item. Subclasses can override this and add custom tooltips to tooltip list.

Overrides:

appendTooltip in class Item

Parameters:

tooltip - the list of tooltips to show

Mappings:

Namespace	Name	Mixin selector
official	a	Lcfs;a(Lcfx;Lcmk;Ljava/util/List;Lcho;)V
intermediary	method_7851	Lnet/minecraft/class_1792;method_7851(Lnet/minecraft/class_1799;Lnet/minecraft/class_1937;Ljava/util/List;Lnet/minecraft/class_1836;)V
named	appendTooltip	Lnet/minecraft/item/Item;appendTooltip(Lnet/minecraft/item/ItemStack;Lnet/minecraft/world/World;Ljava/util/List;Lnet/minecraft/client/item/TooltipContext;)V

onItemEntityDestroyed

public void onItemEntityDestroyed(ItemEntity entity)

Called on the server when an ItemEntity holding this item gets destroyed. This can happen due to fire, lava, cactus, explosion, etc. Items that can hold other items should override this to drop its contents.

Overrides:

onItemEntityDestroyed in class Item

See Also:

• ItemUsage.spawnItemContents(net.minecraft.entity.ItemEntity, java.util.stream.Stream<net.minecraft.item.ItemStack>)

Mappings:

Namespace	Name	Mixin selector
official	a	Lcfs;a(Lbvf;)V
intermediary	method_33261	Lnet/minecraft/class_1792;method_33261(Lnet/minecraft/class_1542;)V
named	onItemEntityDestroyed	Lnet/minecraft/item/Item;onItemEntityDestroyed(Lnet/minecraft/entity/ItemEntity;)V

playRemoveOneSound

private void playRemoveOneSound(Entity entity)

Mappings:

Namespace	Name	Mixin selector
official	a	Lcdz;a(Lbfh;)V
intermediary	method_38074	Lnet/minecraft/class_5537;method_38074(Lnet/minecraft/class_1297;)V
named	playRemoveOneSound	Lnet/minecraft/item/BundleItem;playRemoveOneSound(Lnet/minecraft/entity/Entity;)V

playInsertSound

private void playInsertSound(Entity entity)

Mappings:

Namespace	Name	Mixin selector
official	b	Lcdz;b(Lbfh;)V
intermediary	method_38076	Lnet/minecraft/class_5537;method_38076(Lnet/minecraft/class_1297;)V
named	playInsertSound	Lnet/minecraft/item/BundleItem;playInsertSound(Lnet/minecraft/entity/Entity;)V

playDropContentsSound

private void playDropContentsSound(Entity entity)

Mappings:

Namespace	Name	Mixin selector
official	c	Lcdz;c(Lbfh;)V
intermediary	method_38077	Lnet/minecraft/class_5537;method_38077(Lnet/minecraft/class_1297;)V
named	playDropContentsSound	Lnet/minecraft/item/BundleItem;playDropContentsSound(Lnet/minecraft/entity/Entity;)V