Package alexiil.mc.lib.attributes.item

Class ItemInvUtil

java.lang.Object

alexiil.mc.lib.attributes.item.ItemInvUtil

public final class ItemInvUtil
extends Object

Various hooks and methods for dealing with pairs of FixedItemInv, FixedItemInvView, ItemInsertable, ItemExtractable, and GroupedItemInvView instances.

Nested Class Summary

Nested Classes

Modifier and Type	Class	Description
static class	ItemInvUtil.MultiMoveResult	A pair of ints, representing both the total number of stacks and the total number of items moved by moveMultiple(ItemExtractable, ItemInsertable, ItemFilter, int, int).

Method Summary

Modifier and Type	Method	Description
static void	copyAll(FixedItemInvView inv, List<net.minecraft.item.ItemStack> dest)	Copies every ItemStack held in the given inventory to the given List.
static Consumer<net.minecraft.item.ItemStack>	createPlayerInsertable(net.minecraft.entity.player.PlayerEntity player)	Deprecated, for removal: This API element is subject to removal in a future version. Use PlayerInvUtil.createPlayerInsertable(PlayerEntity) instead
static net.minecraft.item.ItemStack	extractSingle(FixedItemInv inv, int slot, ItemFilter filter, net.minecraft.item.ItemStack toAddWith, int maxAmount, Simulation simulation)	Deprecated, for removal: This API element is subject to removal in a future version. Because this has been moved to FixedItemInv.extractStack(int, ItemFilter, ItemStack, int, Simulation).
static void	insertItemIntoPlayerInventory(net.minecraft.entity.player.PlayerEntity player, net.minecraft.item.ItemStack stack)	Deprecated, for removal: This API element is subject to removal in a future version. Use PlayerInvUtil.insertItemIntoPlayerInventory(PlayerEntity,ItemStack) instead
static net.minecraft.item.ItemStack	insertSingle(FixedItemInv inv, int slot, net.minecraft.item.ItemStack toInsert, Simulation simulation)	Deprecated, for removal: This API element is subject to removal in a future version. Because this has been moved to FixedItemInv.insertStack(int, ItemStack, Simulation).
static int	move(ItemExtractable from, ItemInsertable to, int maximum)	Attempts to move up to the given maximum number of items from the ItemExtractable to the ItemInsertable.
static int	move(ItemExtractable from, ItemInsertable to, ItemFilter filter, int maximum)	Attempts to move up to the given maximum number of items from the ItemExtractable to the ItemInsertable, provided they match the given ItemFilter.
static int	move(ItemExtractable from, ItemInsertable to, ItemFilter filter, int maximum, Simulation simulation)	Attempts to move up to the given maximum number of items from the ItemExtractable to the ItemInsertable, provided they match the given ItemFilter.
static ItemInvUtil.MultiMoveResult	moveMultiple(ItemExtractable from, ItemInsertable to)	Attempts to move as much as possible from the ItemExtractable to the ItemInsertable.
static ItemInvUtil.MultiMoveResult	moveMultiple(ItemExtractable from, ItemInsertable to, int maxStacks, int maxTotal)	Attempts to move a given number of stacks from the ItemExtractable to the ItemInsertable.
static ItemInvUtil.MultiMoveResult	moveMultiple(ItemExtractable from, ItemInsertable to, ItemFilter filter, int maxStacks, int maxTotal)	Attempts to move a given number of stacks from the ItemExtractable to the ItemInsertable.
static Reference<net.minecraft.item.ItemStack>	referenceGuiCursor(net.minecraft.server.network.ServerPlayerEntity player)	Deprecated, for removal: This API element is subject to removal in a future version. Use PlayerInvUtil.referenceGuiCursor(ServerPlayerEntity) instead
static Reference<net.minecraft.item.ItemStack>	referenceHand(net.minecraft.entity.player.PlayerEntity player, net.minecraft.util.Hand hand)	Deprecated, for removal: This API element is subject to removal in a future version. Use PlayerInvUtil.referenceHand(PlayerEntity,Hand) instead

Methods inherited from class java.lang.Object

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

Method Details

createPlayerInsertable

@Deprecated(since="0.6.4",
            forRemoval=true)
public static Consumer<net.minecraft.item.ItemStack> createPlayerInsertable(net.minecraft.entity.player.PlayerEntity player)

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

Use PlayerInvUtil.createPlayerInsertable(PlayerEntity) instead

Returns a Consumer that will call PlayerInvUtil.insertItemIntoPlayerInventory(PlayerEntity, ItemStack) for every ItemStack passed to it.

referenceHand

@Deprecated(since="0.6.4",
            forRemoval=true)
public static Reference<net.minecraft.item.ItemStack> referenceHand(net.minecraft.entity.player.PlayerEntity player,
 net.minecraft.util.Hand hand)

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

Use PlayerInvUtil.referenceHand(PlayerEntity,Hand) instead

Creates a Reference to the what the player is currently holding in the given Hand.

referenceGuiCursor

@Deprecated(since="0.6.4",
            forRemoval=true)
public static Reference<net.minecraft.item.ItemStack> referenceGuiCursor(net.minecraft.server.network.ServerPlayerEntity player)

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

Use PlayerInvUtil.referenceGuiCursor(ServerPlayerEntity) instead

Creates a Reference to the given player's cursor stack, that updates the client whenever it is changed.

insertItemIntoPlayerInventory

@Deprecated(since="0.6.4",
            forRemoval=true)
public static void insertItemIntoPlayerInventory(net.minecraft.entity.player.PlayerEntity player,
 net.minecraft.item.ItemStack stack)

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

Use PlayerInvUtil.insertItemIntoPlayerInventory(PlayerEntity,ItemStack) instead

Either inserts the given item into the player's inventory or drops it in front of them. Note that this will always keep a reference to the passed stack (and might modify it!)

move

public static int move(ItemExtractable from,
 ItemInsertable to,
 int maximum)

Attempts to move up to the given maximum number of items from the ItemExtractable to the ItemInsertable. Note that this only ever moves a single stack, unlike moveMultiple(ItemExtractable, ItemInsertable, ItemFilter, int, int).

Returns:

The number of items moved.

See Also:

move(ItemExtractable, ItemInsertable, ItemFilter, int)

move

public static int move(ItemExtractable from,
 ItemInsertable to,
 ItemFilter filter,
 int maximum)

Attempts to move up to the given maximum number of items from the ItemExtractable to the ItemInsertable, provided they match the given ItemFilter. Note that this only ever moves a single stack, unlike moveMultiple(ItemExtractable, ItemInsertable, ItemFilter, int, int).

Returns:

The number of items moved.

move

public static int move(ItemExtractable from,
 ItemInsertable to,
 ItemFilter filter,
 int maximum,
 Simulation simulation)

Attempts to move up to the given maximum number of items from the ItemExtractable to the ItemInsertable, provided they match the given ItemFilter. Note that this only ever moves a single stack, unlike moveMultiple(ItemExtractable, ItemInsertable, ItemFilter, int, int).

Returns:

The number of items moved.

moveMultiple

public static ItemInvUtil.MultiMoveResult moveMultiple(ItemExtractable from,
 ItemInsertable to)

Attempts to move as much as possible from the ItemExtractable to the ItemInsertable. Internally this calls moveMultiple(ItemExtractable, ItemInsertable, int, int) with Integer.MAX_VALUE as the maximum value for both arguments.

Returns:

The ItemInvUtil.MultiMoveResult

moveMultiple

public static ItemInvUtil.MultiMoveResult moveMultiple(ItemExtractable from,
 ItemInsertable to,
 int maxStacks,
 int maxTotal)

Attempts to move a given number of stacks from the ItemExtractable to the ItemInsertable. Internally this calls move(ItemExtractable, ItemInsertable, int) in a loop from 1 to maxStacks.

Returns:

The ItemInvUtil.MultiMoveResult

moveMultiple

public static ItemInvUtil.MultiMoveResult moveMultiple(ItemExtractable from,
 ItemInsertable to,
 ItemFilter filter,
 int maxStacks,
 int maxTotal)

Attempts to move a given number of stacks from the ItemExtractable to the ItemInsertable. Internally this calls move(ItemExtractable, ItemInsertable, int) in a loop from 1 to maxStacks.

Returns:

The ItemInvUtil.MultiMoveResult

copyAll

public static void copyAll(FixedItemInvView inv,
 List<net.minecraft.item.ItemStack> dest)

Copies every ItemStack held in the given inventory to the given List.

insertSingle

@Deprecated(since="0.8.0",
            forRemoval=true)
public static net.minecraft.item.ItemStack insertSingle(FixedItemInv inv,
 int slot,
 net.minecraft.item.ItemStack toInsert,
 Simulation simulation)

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

Because this has been moved to FixedItemInv.insertStack(int, ItemStack, Simulation).

Inserts a single ItemStack into a FixedItemInv, using only FixedItemInv.setInvStack(int, ItemStack, Simulation). As such this is useful for implementations of ItemInsertable (or others) for the base implementation.

Parameters:

toInsert - The stack to insert. This won't be modified.

Returns:

The excess ItemStack that wasn't inserted.

extractSingle

@Deprecated(since="0.8.0",
            forRemoval=true)
public static net.minecraft.item.ItemStack extractSingle(FixedItemInv inv,
 int slot,
 @Nullable
 ItemFilter filter,
 net.minecraft.item.ItemStack toAddWith,
 int maxAmount,
 Simulation simulation)

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

Because this has been moved to FixedItemInv.extractStack(int, ItemFilter, ItemStack, int, Simulation).

Extracts a single ItemStack from a FixedItemInv, using only FixedItemInv.setInvStack(int, ItemStack, Simulation). As such this is useful for implementations of ItemInsertable (or others) for the base implementation.

Parameters:

filter - The filter to match on. If this is null then it will match any ItemStack.

toAddWith - An optional ItemStack that the extracted item will be added to.

maxAmount - The maximum number of items to extract. Note that the returned ItemStack may have a higher amount than this if the given ItemStack isn't empty.

Returns:

The extracted ItemStack, plus the parameter "toAddWith".