Package net.neoforged.neoforge.items

Class ItemHandlerHelper

java.lang.Object

net.neoforged.neoforge.items.ItemHandlerHelper

public class ItemHandlerHelper
extends Object

Constructor Summary

Constructors

Constructor	Description
ItemHandlerHelper()

Method Summary

Modifier and Type	Method	Description
static int	calcRedstoneFromInventory(@Nullable IItemHandler inv)	This method uses the standard vanilla algorithm to calculate a comparator output for how "full" the inventory is.
static boolean	canItemStacksStack(ItemStack a, ItemStack b)	Deprecated, for removal: This API element is subject to removal in a future version. Use ItemStack.isSameItemSameComponents(ItemStack, ItemStack)
static ItemStack	copyStackWithSize(ItemStack stack, int count)	Deprecated, for removal: This API element is subject to removal in a future version. Use ItemStack.copyWithCount(int)
static void	giveItemToPlayer(Player player, ItemStack stack)	giveItemToPlayer without preferred slot
static void	giveItemToPlayer(Player player, ItemStack stack, int preferredSlot)	Inserts the given itemstack into the players inventory.
static ItemStack	insertItem(IItemHandler dest, ItemStack stack, boolean simulate)
static ItemStack	insertItemStacked(IItemHandler inventory, ItemStack stack, boolean simulate)	Inserts the ItemStack into the inventory, filling up already present stacks first.

Methods inherited from class java.lang.Object

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

Constructor Details

ItemHandlerHelper

public ItemHandlerHelper()

Method Details

insertItem

public static ItemStack insertItem(IItemHandler dest,
 ItemStack stack,
 boolean simulate)

canItemStacksStack

@Deprecated(forRemoval=true,
            since="1.20.5")
public static boolean canItemStacksStack(ItemStack a,
 ItemStack b)

Deprecated, for removal: This API element is subject to removal in a future version.

Use ItemStack.isSameItemSameComponents(ItemStack, ItemStack)

copyStackWithSize

@Deprecated(forRemoval=true,
            since="1.20.5")
public static ItemStack copyStackWithSize(ItemStack stack,
 int count)

Deprecated, for removal: This API element is subject to removal in a future version.

Use ItemStack.copyWithCount(int)

insertItemStacked

public static ItemStack insertItemStacked(IItemHandler inventory,
 ItemStack stack,
 boolean simulate)

Inserts the ItemStack into the inventory, filling up already present stacks first. This is equivalent to the behaviour of a player picking up an item. Note: This function stacks items without subtypes with different metadata together.

giveItemToPlayer

public static void giveItemToPlayer(Player player,
 ItemStack stack)

giveItemToPlayer without preferred slot

giveItemToPlayer

public static void giveItemToPlayer(Player player,
 ItemStack stack,
 int preferredSlot)

Inserts the given itemstack into the players inventory. If the inventory can't hold it, the item will be dropped in the world at the players position.

Parameters:

player - The player to give the item to

stack - The itemstack to insert

calcRedstoneFromInventory

public static int calcRedstoneFromInventory(@Nullable
 @Nullable IItemHandler inv)

This method uses the standard vanilla algorithm to calculate a comparator output for how "full" the inventory is. This method is an adaptation of Container#calcRedstoneFromInventory(IInventory).

Parameters:

inv - The inventory handler to test.

Returns:

A redstone value in the range [0,15] representing how "full" this inventory is.