Class ItemContainer

java.lang.Object

com.hypixel.hytale.server.core.inventory.container.ItemContainer

Direct Known Subclasses:

CombinedItemContainer, DelegateItemContainer, EmptyItemContainer, FetchedItemContainer, ItemStackItemContainer, SimpleItemContainer

public abstract class ItemContainer
extends Object

Since:

20/11/16.

Version:

1.0

Nested Class Summary

Nested Classes

Modifier and Type	Class	Description
static final record	ItemContainer.ItemContainerChangeEvent
static final record	ItemContainer.TempItemData

Field Summary

Fields

Modifier and Type	Field	Description
static final CodecMapCodec<ItemContainer>	CODEC
static final boolean	DEFAULT_ADD_ALL_OR_NOTHING	If set to true then we should add/remove the whole quantity of items/resources and no less or else we will fail.
static final boolean	DEFAULT_EXACT_AMOUNT	Used in the cases of resources since a 1 item can be worth multiple of a resource so this prevents resource loss.
static final boolean	DEFAULT_FILTER	Should catAdd, cantRemove and cantDrop be checked when adding, removing or dropping items
static final boolean	DEFAULT_FULL_STACKS	Should added items only be added to empty item slots and will *NOT* be combined with existing stacks of equivalent type.
static final boolean	DEFAULT_REMOVE_ALL_OR_NOTHING

Constructor Summary

Constructors

Constructor	Description
ItemContainer()

Method Summary

Modifier and Type	Method	Description
ItemStackTransaction	addItemStack(ItemStack itemStack)	Add an ItemStack to this container
ItemStackTransaction	addItemStack(ItemStack itemStack, boolean allOrNothing, boolean fullStacks, boolean filter)	Add an ItemStack to this container
ListTransaction<ItemStackTransaction>	addItemStacks(List<ItemStack> itemStacks)
ListTransaction<ItemStackTransaction>	addItemStacks(List<ItemStack> itemStacks, boolean allOrNothing, boolean fullStacks, boolean filter)
ListTransaction<ItemStackSlotTransaction>	addItemStacksOrdered(short offset, List<ItemStack> itemStacks)
ListTransaction<ItemStackSlotTransaction>	addItemStacksOrdered(short offset, List<ItemStack> itemStacks, boolean allOrNothing, boolean filter)	Adds ItemStacks to the item container using one ItemStack per slot.
ListTransaction<ItemStackSlotTransaction>	addItemStacksOrdered(List<ItemStack> itemStacks)
ListTransaction<ItemStackSlotTransaction>	addItemStacksOrdered(List<ItemStack> itemStacks, boolean allOrNothing, boolean filter)
ItemStackSlotTransaction	addItemStackToSlot(short slot, ItemStack itemStack)
ItemStackSlotTransaction	addItemStackToSlot(short slot, ItemStack itemStack, boolean allOrNothing, boolean filter)
boolean	canAddItemStack(ItemStack itemStack)
boolean	canAddItemStack(ItemStack itemStack, boolean fullStacks, boolean filter)
boolean	canAddItemStacks(List<ItemStack> itemStacks)
boolean	canAddItemStacks(List<ItemStack> itemStacks, boolean fullStacks, boolean filter)
boolean	canAddItemStackToSlot(short slot, ItemStack itemStack, boolean allOrNothing, boolean filter)
boolean	canRemoveItemStack(ItemStack itemStack)
boolean	canRemoveItemStack(ItemStack itemStack, boolean exactAmount, boolean filter)
boolean	canRemoveItemStacks(List<ItemStack> itemStacks)
boolean	canRemoveItemStacks(List<ItemStack> itemStacks, boolean exactAmount, boolean filter)
boolean	canRemoveMaterial(MaterialQuantity material)
boolean	canRemoveMaterial(MaterialQuantity material, boolean exactAmount, boolean filter)
boolean	canRemoveMaterials(List<MaterialQuantity> materials)
boolean	canRemoveMaterials(List<MaterialQuantity> materials, boolean exactAmount, boolean filter)
boolean	canRemoveResource(ResourceQuantity resource)
boolean	canRemoveResource(ResourceQuantity resource, boolean exactAmount, boolean filter)
boolean	canRemoveResources(List<ResourceQuantity> resources)
boolean	canRemoveResources(List<ResourceQuantity> resources, boolean exactAmount, boolean filter)
boolean	canRemoveTag(int tagIndex, int quantity)
boolean	canRemoveTag(int tagIndex, int quantity, boolean exactAmount, boolean filter)
ClearTransaction	clear()
abstract ItemContainer	clone()
ListTransaction<MoveTransaction<SlotTransaction>>	combineItemStacksIntoSlot(ItemContainer containerTo, short slotTo)
boolean	containsContainer(ItemContainer itemContainer)
boolean	containsItemStacksStackableWith(ItemStack itemStack)
static <T extends ItemContainer> T	copy(ItemContainer from, T to, List<ItemStack> remainder)
int	countItemStacks(Predicate<ItemStack> itemPredicate)
int	countRemovableMaterial(MaterialQuantity material)
int	countRemovableMaterial(MaterialQuantity material, boolean filter)
void	doMigration(Function<String,String> blockMigration)
List<ItemStack>	dropAllItemStacks()
List<ItemStack>	dropAllItemStacks(boolean filter)
static <T extends ItemContainer> T	ensureContainerCapacity(T inputContainer, short capacity, com.hypixel.fastutil.shorts.Short2ObjectConcurrentHashMap.ShortFunction<T> newContainerSupplier, List<ItemStack> remainder)
void	forEach(ShortObjectConsumer<ItemStack> action)
<T> void	forEachWithMeta(com.hypixel.fastutil.shorts.Short2ObjectConcurrentHashMap.ShortBiObjConsumer<ItemStack, T> consumer, T meta)
abstract short	getCapacity()
ItemStack	getItemStack(short slot)
static ItemResourceType	getMatchingResourceType(Item item, String resourceId)	Helper to get the resource type from an item that matches the given resource ID
static ItemContainer	getNewContainer(short capacity, com.hypixel.fastutil.shorts.Short2ObjectConcurrentHashMap.ShortFunction<ItemContainer> supplier)
List<TestRemoveItemSlotResult>	getSlotMaterialsToRemove(List<MaterialQuantity> materials, boolean exactAmount, boolean filter)
ItemStackSlotTransaction	internal_removeItemStack(short slot, int quantityToRemove)	Deprecated.
boolean	isEmpty()
ListTransaction<MoveTransaction<ItemStackTransaction>>	moveAllItemStacksTo(ItemContainer... containerTo)
ListTransaction<MoveTransaction<ItemStackTransaction>>	moveAllItemStacksTo(Predicate<ItemStack> itemPredicate, ItemContainer... containerTo)
ListTransaction<MoveTransaction<ItemStackTransaction>>	moveItemStackFromSlot(short slot, boolean allOrNothing, boolean filter, ItemContainer... containerTo)
ListTransaction<MoveTransaction<ItemStackTransaction>>	moveItemStackFromSlot(short slot, int quantity, boolean allOrNothing, boolean filter, ItemContainer... containerTo)
MoveTransaction<ItemStackTransaction>	moveItemStackFromSlot(short slot, int quantity, ItemContainer containerTo)
ListTransaction<MoveTransaction<ItemStackTransaction>>	moveItemStackFromSlot(short slot, int quantity, ItemContainer... containerTo)
MoveTransaction<ItemStackTransaction>	moveItemStackFromSlot(short slot, int quantity, ItemContainer containerTo, boolean allOrNothing, boolean filter)
MoveTransaction<ItemStackTransaction>	moveItemStackFromSlot(short slot, ItemContainer containerTo)
ListTransaction<MoveTransaction<ItemStackTransaction>>	moveItemStackFromSlot(short slot, ItemContainer... containerTo)
MoveTransaction<ItemStackTransaction>	moveItemStackFromSlot(short slot, ItemContainer containerTo, boolean filter)
MoveTransaction<ItemStackTransaction>	moveItemStackFromSlot(short slot, ItemContainer containerTo, boolean allOrNothing, boolean filter)
MoveTransaction<SlotTransaction>	moveItemStackFromSlotToSlot(short slot, int quantity, ItemContainer containerTo, short slotTo)
MoveTransaction<SlotTransaction>	moveItemStackFromSlotToSlot(short slot, int quantity, ItemContainer containerTo, short slotTo, boolean filter)
ListTransaction<MoveTransaction<ItemStackTransaction>>	quickStackTo(ItemContainer... containerTo)
EventRegistration<Void, ItemContainer.ItemContainerChangeEvent>	registerChangeEvent(short priority, Consumer<ItemContainer.ItemContainerChangeEvent> consumer)
EventRegistration<Void, ItemContainer.ItemContainerChangeEvent>	registerChangeEvent(EventPriority priority, Consumer<ItemContainer.ItemContainerChangeEvent> consumer)
EventRegistration<Void, ItemContainer.ItemContainerChangeEvent>	registerChangeEvent(Consumer<ItemContainer.ItemContainerChangeEvent> consumer)
List<ItemStack>	removeAllItemStacks()
ItemStackTransaction	removeItemStack(ItemStack itemStack)
ItemStackTransaction	removeItemStack(ItemStack itemStack, boolean allOrNothing, boolean filter)
SlotTransaction	removeItemStackFromSlot(short slot)
SlotTransaction	removeItemStackFromSlot(short slot, boolean filter)
ItemStackSlotTransaction	removeItemStackFromSlot(short slot, int quantityToRemove)
ItemStackSlotTransaction	removeItemStackFromSlot(short slot, int quantityToRemove, boolean allOrNothing, boolean filter)
ItemStackSlotTransaction	removeItemStackFromSlot(short slot, ItemStack itemStackToRemove, int quantityToRemove)
ItemStackSlotTransaction	removeItemStackFromSlot(short slot, ItemStack itemStackToRemove, int quantityToRemove, boolean allOrNothing, boolean filter)
ListTransaction<ItemStackTransaction>	removeItemStacks(List<ItemStack> itemStacks)
ListTransaction<ItemStackTransaction>	removeItemStacks(List<ItemStack> itemStacks, boolean allOrNothing, boolean filter)
MaterialTransaction	removeMaterial(MaterialQuantity material)
MaterialTransaction	removeMaterial(MaterialQuantity material, boolean allOrNothing, boolean exactAmount, boolean filter)
MaterialSlotTransaction	removeMaterialFromSlot(short slot, MaterialQuantity material)
MaterialSlotTransaction	removeMaterialFromSlot(short slot, MaterialQuantity material, boolean allOrNothing, boolean exactAmount, boolean filter)
ListTransaction<MaterialTransaction>	removeMaterials(List<MaterialQuantity> materials)
ListTransaction<MaterialTransaction>	removeMaterials(List<MaterialQuantity> materials, boolean allOrNothing, boolean exactAmount, boolean filter)
ListTransaction<MaterialSlotTransaction>	removeMaterialsOrdered(short offset, List<MaterialQuantity> materials)
ListTransaction<MaterialSlotTransaction>	removeMaterialsOrdered(short offset, List<MaterialQuantity> materials, boolean allOrNothing, boolean exactAmount, boolean filter)	Removes materials from the item container using one material per slot.
ListTransaction<MaterialSlotTransaction>	removeMaterialsOrdered(List<MaterialQuantity> materials, boolean allOrNothing, boolean exactAmount, boolean filter)
ResourceTransaction	removeResource(ResourceQuantity resource)
ResourceTransaction	removeResource(ResourceQuantity resource, boolean allOrNothing, boolean exactAmount, boolean filter)
ResourceSlotTransaction	removeResourceFromSlot(short slot, ResourceQuantity resource)
ResourceSlotTransaction	removeResourceFromSlot(short slot, ResourceQuantity resource, boolean allOrNothing, boolean exactAmount, boolean filter)
ListTransaction<ResourceTransaction>	removeResources(List<ResourceQuantity> resources)
ListTransaction<ResourceTransaction>	removeResources(List<ResourceQuantity> resources, boolean allOrNothing, boolean exactAmount, boolean filter)
TagTransaction	removeTag(int tagIndex, int quantity)
TagTransaction	removeTag(int tagIndex, int quantity, boolean allOrNothing, boolean exactAmount, boolean filter)
TagSlotTransaction	removeTagFromSlot(short slot, int tagIndex, int quantity)
TagSlotTransaction	removeTagFromSlot(short slot, int tagIndex, int quantity, boolean allOrNothing, boolean filter)
ListTransaction<ItemStackSlotTransaction>	replaceAll(SlotReplacementFunction func)
ItemStackSlotTransaction	replaceItemStackInSlot(short slot, ItemStack itemStackToRemove, ItemStack itemStack)
abstract void	setGlobalFilter(FilterType globalFilter)
ItemStackSlotTransaction	setItemStackForSlot(short slot, ItemStack itemStack)
ItemStackSlotTransaction	setItemStackForSlot(short slot, ItemStack itemStack, boolean filter)
abstract void	setSlotFilter(FilterActionType actionType, short slot, SlotFilter filter)
ListTransaction<SlotTransaction>	sortItems(SortType sort)
ListTransaction<MoveTransaction<SlotTransaction>>	swapItems(short srcPos, ItemContainer containerTo, short destPos, short length)
InventorySection	toPacket()
Map<Integer, ItemWithAllMetadata>	toProtocolMap()
static void	validateQuantity(int quantity)
static void	validateSlotIndex(short slot, int capacity)

Methods inherited from class Object

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

Field Details

CODEC

public static final CodecMapCodec<ItemContainer> CODEC

DEFAULT_ADD_ALL_OR_NOTHING

public static final boolean DEFAULT_ADD_ALL_OR_NOTHING

If set to true then we should add/remove the whole quantity of items/resources and no less or else we will fail. If set to false then we will allow less than the quantity specified to be removed and the remainder to be removed will be specified in the returned transaction.

See Also:

• Constant Field Values

DEFAULT_REMOVE_ALL_OR_NOTHING

public static final boolean DEFAULT_REMOVE_ALL_OR_NOTHING

See Also:

• Constant Field Values

DEFAULT_FULL_STACKS

public static final boolean DEFAULT_FULL_STACKS

Should added items only be added to empty item slots and will *NOT* be combined with existing stacks of equivalent type.

See Also:

• Constant Field Values

DEFAULT_EXACT_AMOUNT

public static final boolean DEFAULT_EXACT_AMOUNT

Used in the cases of resources since a 1 item can be worth multiple of a resource so this prevents resource loss. Eg. 1 Trunk item may actually be worth 2 Wood resource so if you said remove 3 Wood and you had 2 Trunks you would technically lose 1 wood worth of resources if both items get removed so by setting exact amount to true it forces removal of exactly only 3 wood worth of resources.

See Also:

• Constant Field Values

DEFAULT_FILTER

public static final boolean DEFAULT_FILTER

Should catAdd, cantRemove and cantDrop be checked when adding, removing or dropping items

See Also:

• Constant Field Values

Constructor Details

ItemContainer

public ItemContainer()

Method Details

getCapacity

public abstract short getCapacity()

setGlobalFilter

public abstract void setGlobalFilter(FilterType globalFilter)

setSlotFilter

public abstract void setSlotFilter(FilterActionType actionType,
 short slot,
 SlotFilter filter)

clone

public abstract ItemContainer clone()

toPacket

@Nonnull
public InventorySection toPacket()

toProtocolMap

@Nonnull
public Map<Integer, ItemWithAllMetadata> toProtocolMap()

registerChangeEvent

public EventRegistration<Void, ItemContainer.ItemContainerChangeEvent> registerChangeEvent(@Nonnull
 Consumer<ItemContainer.ItemContainerChangeEvent> consumer)

registerChangeEvent

public EventRegistration<Void, ItemContainer.ItemContainerChangeEvent> registerChangeEvent(@Nonnull
 EventPriority priority,
 @Nonnull
 Consumer<ItemContainer.ItemContainerChangeEvent> consumer)

registerChangeEvent

public EventRegistration<Void, ItemContainer.ItemContainerChangeEvent> registerChangeEvent(short priority,
 @Nonnull
 Consumer<ItemContainer.ItemContainerChangeEvent> consumer)

clear

public ClearTransaction clear()

canAddItemStackToSlot

public boolean canAddItemStackToSlot(short slot,
 @Nonnull
 ItemStack itemStack,
 boolean allOrNothing,
 boolean filter)

addItemStackToSlot

@Nonnull
public ItemStackSlotTransaction addItemStackToSlot(short slot,
 @Nonnull
 ItemStack itemStack)

addItemStackToSlot

@Nonnull
public ItemStackSlotTransaction addItemStackToSlot(short slot,
 @Nonnull
 ItemStack itemStack,
 boolean allOrNothing,
 boolean filter)

setItemStackForSlot

@Nonnull
public ItemStackSlotTransaction setItemStackForSlot(short slot,
 ItemStack itemStack)

setItemStackForSlot

@Nonnull
public ItemStackSlotTransaction setItemStackForSlot(short slot,
 ItemStack itemStack,
 boolean filter)

getItemStack

@Nullable
public ItemStack getItemStack(short slot)

replaceItemStackInSlot

@Nonnull
public ItemStackSlotTransaction replaceItemStackInSlot(short slot,
 ItemStack itemStackToRemove,
 ItemStack itemStack)

replaceAll

public ListTransaction<ItemStackSlotTransaction> replaceAll(SlotReplacementFunction func)

removeItemStackFromSlot

@Nonnull
public SlotTransaction removeItemStackFromSlot(short slot)

removeItemStackFromSlot

@Nonnull
public SlotTransaction removeItemStackFromSlot(short slot,
 boolean filter)

removeItemStackFromSlot

@Nonnull
public ItemStackSlotTransaction removeItemStackFromSlot(short slot,
 int quantityToRemove)

removeItemStackFromSlot

@Nonnull
public ItemStackSlotTransaction removeItemStackFromSlot(short slot,
 int quantityToRemove,
 boolean allOrNothing,
 boolean filter)

internal_removeItemStack

@Deprecated
public ItemStackSlotTransaction internal_removeItemStack(short slot,
 int quantityToRemove)

Deprecated.

removeItemStackFromSlot

@Nonnull
public ItemStackSlotTransaction removeItemStackFromSlot(short slot,
 ItemStack itemStackToRemove,
 int quantityToRemove)

removeItemStackFromSlot

@Nonnull
public ItemStackSlotTransaction removeItemStackFromSlot(short slot,
 ItemStack itemStackToRemove,
 int quantityToRemove,
 boolean allOrNothing,
 boolean filter)

removeMaterialFromSlot

@Nonnull
public MaterialSlotTransaction removeMaterialFromSlot(short slot,
 @Nonnull
 MaterialQuantity material)

removeMaterialFromSlot

@Nonnull
public MaterialSlotTransaction removeMaterialFromSlot(short slot,
 @Nonnull
 MaterialQuantity material,
 boolean allOrNothing,
 boolean exactAmount,
 boolean filter)

removeResourceFromSlot

@Nonnull
public ResourceSlotTransaction removeResourceFromSlot(short slot,
 @Nonnull
 ResourceQuantity resource)

removeResourceFromSlot

@Nonnull
public ResourceSlotTransaction removeResourceFromSlot(short slot,
 @Nonnull
 ResourceQuantity resource,
 boolean allOrNothing,
 boolean exactAmount,
 boolean filter)

removeTagFromSlot

@Nonnull
public TagSlotTransaction removeTagFromSlot(short slot,
 int tagIndex,
 int quantity)

removeTagFromSlot

@Nonnull
public TagSlotTransaction removeTagFromSlot(short slot,
 int tagIndex,
 int quantity,
 boolean allOrNothing,
 boolean filter)

moveItemStackFromSlot

@Nonnull
public MoveTransaction<ItemStackTransaction> moveItemStackFromSlot(short slot,
 @Nonnull
 ItemContainer containerTo)

moveItemStackFromSlot

@Nonnull
public MoveTransaction<ItemStackTransaction> moveItemStackFromSlot(short slot,
 @Nonnull
 ItemContainer containerTo,
 boolean filter)

moveItemStackFromSlot

@Nonnull
public MoveTransaction<ItemStackTransaction> moveItemStackFromSlot(short slot,
 @Nonnull
 ItemContainer containerTo,
 boolean allOrNothing,
 boolean filter)

moveItemStackFromSlot

@Nonnull
public MoveTransaction<ItemStackTransaction> moveItemStackFromSlot(short slot,
 int quantity,
 @Nonnull
 ItemContainer containerTo)

moveItemStackFromSlot

@Nonnull
public MoveTransaction<ItemStackTransaction> moveItemStackFromSlot(short slot,
 int quantity,
 @Nonnull
 ItemContainer containerTo,
 boolean allOrNothing,
 boolean filter)

moveItemStackFromSlot

@Nonnull
public ListTransaction<MoveTransaction<ItemStackTransaction>> moveItemStackFromSlot(short slot,
 ItemContainer... containerTo)

moveItemStackFromSlot

@Nonnull
public ListTransaction<MoveTransaction<ItemStackTransaction>> moveItemStackFromSlot(short slot,
 boolean allOrNothing,
 boolean filter,
 @Nonnull
 ItemContainer... containerTo)

moveItemStackFromSlot

@Nonnull
public ListTransaction<MoveTransaction<ItemStackTransaction>> moveItemStackFromSlot(short slot,
 int quantity,
 ItemContainer... containerTo)

moveItemStackFromSlot

@Nonnull
public ListTransaction<MoveTransaction<ItemStackTransaction>> moveItemStackFromSlot(short slot,
 int quantity,
 boolean allOrNothing,
 boolean filter,
 @Nonnull
 ItemContainer... containerTo)

moveItemStackFromSlotToSlot

@Nonnull
public MoveTransaction<SlotTransaction> moveItemStackFromSlotToSlot(short slot,
 int quantity,
 @Nonnull
 ItemContainer containerTo,
 short slotTo)

moveItemStackFromSlotToSlot

@Nonnull
public MoveTransaction<SlotTransaction> moveItemStackFromSlotToSlot(short slot,
 int quantity,
 @Nonnull
 ItemContainer containerTo,
 short slotTo,
 boolean filter)

moveAllItemStacksTo

@Nonnull
public ListTransaction<MoveTransaction<ItemStackTransaction>> moveAllItemStacksTo(ItemContainer... containerTo)

moveAllItemStacksTo

@Nonnull
public ListTransaction<MoveTransaction<ItemStackTransaction>> moveAllItemStacksTo(Predicate<ItemStack> itemPredicate,
 ItemContainer... containerTo)

quickStackTo

@Nonnull
public ListTransaction<MoveTransaction<ItemStackTransaction>> quickStackTo(@Nonnull
 ItemContainer... containerTo)

combineItemStacksIntoSlot

@Nonnull
public ListTransaction<MoveTransaction<SlotTransaction>> combineItemStacksIntoSlot(@Nonnull
 ItemContainer containerTo,
 short slotTo)

swapItems

@Nonnull
public ListTransaction<MoveTransaction<SlotTransaction>> swapItems(short srcPos,
 @Nonnull
 ItemContainer containerTo,
 short destPos,
 short length)

canAddItemStack

public boolean canAddItemStack(@Nonnull
 ItemStack itemStack)

canAddItemStack

public boolean canAddItemStack(@Nonnull
 ItemStack itemStack,
 boolean fullStacks,
 boolean filter)

addItemStack

@Nonnull
public ItemStackTransaction addItemStack(@Nonnull
 ItemStack itemStack)

Add an ItemStack to this container

Parameters:

itemStack - The ItemStack to add

Returns:

The remaining ItemStack that couldn't be added

addItemStack

@Nonnull
public ItemStackTransaction addItemStack(@Nonnull
 ItemStack itemStack,
 boolean allOrNothing,
 boolean fullStacks,
 boolean filter)

Add an ItemStack to this container

Parameters:

itemStack - The ItemStack to add

allOrNothing - If true the whole ItemStack must be placed in the container or will be returned as remaining

fullStacks - Only the full stack into a single slot

Returns:

The remaining ItemStack that couldn't be added

canAddItemStacks

public boolean canAddItemStacks(List<ItemStack> itemStacks)

canAddItemStacks

public boolean canAddItemStacks(@Nullable
 List<ItemStack> itemStacks,
 boolean fullStacks,
 boolean filter)

addItemStacks

public ListTransaction<ItemStackTransaction> addItemStacks(List<ItemStack> itemStacks)

addItemStacks

public ListTransaction<ItemStackTransaction> addItemStacks(@Nullable
 List<ItemStack> itemStacks,
 boolean allOrNothing,
 boolean fullStacks,
 boolean filter)

addItemStacksOrdered

public ListTransaction<ItemStackSlotTransaction> addItemStacksOrdered(List<ItemStack> itemStacks)

addItemStacksOrdered

public ListTransaction<ItemStackSlotTransaction> addItemStacksOrdered(short offset,
 List<ItemStack> itemStacks)

addItemStacksOrdered

public ListTransaction<ItemStackSlotTransaction> addItemStacksOrdered(List<ItemStack> itemStacks,
 boolean allOrNothing,
 boolean filter)

addItemStacksOrdered

public ListTransaction<ItemStackSlotTransaction> addItemStacksOrdered(short offset,
 @Nullable
 List<ItemStack> itemStacks,
 boolean allOrNothing,
 boolean filter)

Adds ItemStacks to the item container using one ItemStack per slot. Eg addItemStacksOrdered with 2 ItemStacks Rock_Stone and Wood_Ash_Trunk will add the Rock_Stone ItemStack to slot offset and the Wood_Ash_Trunk to slot (offset + 1).

canRemoveItemStack

public boolean canRemoveItemStack(ItemStack itemStack)

canRemoveItemStack

public boolean canRemoveItemStack(@Nullable
 ItemStack itemStack,
 boolean exactAmount,
 boolean filter)

removeItemStack

@Nonnull
public ItemStackTransaction removeItemStack(@Nonnull
 ItemStack itemStack)

removeItemStack

@Nonnull
public ItemStackTransaction removeItemStack(@Nonnull
 ItemStack itemStack,
 boolean allOrNothing,
 boolean filter)

canRemoveItemStacks

public boolean canRemoveItemStacks(List<ItemStack> itemStacks)

canRemoveItemStacks

public boolean canRemoveItemStacks(@Nullable
 List<ItemStack> itemStacks,
 boolean exactAmount,
 boolean filter)

removeItemStacks

public ListTransaction<ItemStackTransaction> removeItemStacks(List<ItemStack> itemStacks)

removeItemStacks

public ListTransaction<ItemStackTransaction> removeItemStacks(@Nullable
 List<ItemStack> itemStacks,
 boolean allOrNothing,
 boolean filter)

canRemoveTag

public boolean canRemoveTag(int tagIndex,
 int quantity)

canRemoveTag

public boolean canRemoveTag(int tagIndex,
 int quantity,
 boolean exactAmount,
 boolean filter)

removeTag

@Nonnull
public TagTransaction removeTag(int tagIndex,
 int quantity)

removeTag

@Nonnull
public TagTransaction removeTag(int tagIndex,
 int quantity,
 boolean allOrNothing,
 boolean exactAmount,
 boolean filter)

canRemoveResource

public boolean canRemoveResource(ResourceQuantity resource)

canRemoveResource

public boolean canRemoveResource(@Nullable
 ResourceQuantity resource,
 boolean exactAmount,
 boolean filter)

removeResource

@Nonnull
public ResourceTransaction removeResource(@Nonnull
 ResourceQuantity resource)

removeResource

@Nonnull
public ResourceTransaction removeResource(@Nonnull
 ResourceQuantity resource,
 boolean allOrNothing,
 boolean exactAmount,
 boolean filter)

canRemoveResources

public boolean canRemoveResources(List<ResourceQuantity> resources)

canRemoveResources

public boolean canRemoveResources(@Nullable
 List<ResourceQuantity> resources,
 boolean exactAmount,
 boolean filter)

removeResources

public ListTransaction<ResourceTransaction> removeResources(List<ResourceQuantity> resources)

removeResources

public ListTransaction<ResourceTransaction> removeResources(@Nullable
 List<ResourceQuantity> resources,
 boolean allOrNothing,
 boolean exactAmount,
 boolean filter)

canRemoveMaterial

public boolean canRemoveMaterial(MaterialQuantity material)

canRemoveMaterial

public boolean canRemoveMaterial(@Nullable
 MaterialQuantity material,
 boolean exactAmount,
 boolean filter)

countRemovableMaterial

public int countRemovableMaterial(@Nonnull
 MaterialQuantity material)

countRemovableMaterial

public int countRemovableMaterial(@Nonnull
 MaterialQuantity material,
 boolean filter)

Returns:

the total amount of the given material that could be removed from this container. Matches item-id, resource-type and tag materials through the same logic as canRemoveMaterial(MaterialQuantity).

removeMaterial

@Nonnull
public MaterialTransaction removeMaterial(@Nonnull
 MaterialQuantity material)

removeMaterial

@Nonnull
public MaterialTransaction removeMaterial(@Nonnull
 MaterialQuantity material,
 boolean allOrNothing,
 boolean exactAmount,
 boolean filter)

canRemoveMaterials

public boolean canRemoveMaterials(List<MaterialQuantity> materials)

canRemoveMaterials

public boolean canRemoveMaterials(@Nullable
 List<MaterialQuantity> materials,
 boolean exactAmount,
 boolean filter)

getSlotMaterialsToRemove

public List<TestRemoveItemSlotResult> getSlotMaterialsToRemove(@Nullable
 List<MaterialQuantity> materials,
 boolean exactAmount,
 boolean filter)

removeMaterials

public ListTransaction<MaterialTransaction> removeMaterials(List<MaterialQuantity> materials)

removeMaterials

public ListTransaction<MaterialTransaction> removeMaterials(@Nullable
 List<MaterialQuantity> materials,
 boolean allOrNothing,
 boolean exactAmount,
 boolean filter)

removeMaterialsOrdered

public ListTransaction<MaterialSlotTransaction> removeMaterialsOrdered(short offset,
 List<MaterialQuantity> materials)

removeMaterialsOrdered

public ListTransaction<MaterialSlotTransaction> removeMaterialsOrdered(List<MaterialQuantity> materials,
 boolean allOrNothing,
 boolean exactAmount,
 boolean filter)

removeMaterialsOrdered

public ListTransaction<MaterialSlotTransaction> removeMaterialsOrdered(short offset,
 @Nullable
 List<MaterialQuantity> materials,
 boolean allOrNothing,
 boolean exactAmount,
 boolean filter)

Removes materials from the item container using one material per slot. Eg removeMaterialsOrdered with 2 materials Wood and Copper Ingot will remove the Wood material from slot offset and the Copper Ingot from slot (offset + 1).

isEmpty

public boolean isEmpty()

countItemStacks

public int countItemStacks(@Nonnull
 Predicate<ItemStack> itemPredicate)

containsItemStacksStackableWith

public boolean containsItemStacksStackableWith(@Nonnull
 ItemStack itemStack)

forEach

public void forEach(@Nonnull
 ShortObjectConsumer<ItemStack> action)

forEachWithMeta

public <T> void forEachWithMeta(@Nonnull
 com.hypixel.fastutil.shorts.Short2ObjectConcurrentHashMap.ShortBiObjConsumer<ItemStack, T> consumer,
 T meta)

removeAllItemStacks

@Nonnull
public List<ItemStack> removeAllItemStacks()

dropAllItemStacks

@Nonnull
public List<ItemStack> dropAllItemStacks()

dropAllItemStacks

@Nonnull
public List<ItemStack> dropAllItemStacks(boolean filter)

sortItems

@Nonnull
public ListTransaction<SlotTransaction> sortItems(@Nonnull
 SortType sort)

containsContainer

public boolean containsContainer(ItemContainer itemContainer)

doMigration

public void doMigration(Function<String,String> blockMigration)

getMatchingResourceType

@Nullable
public static ItemResourceType getMatchingResourceType(@Nonnull
 Item item,
 @Nonnull
 String resourceId)

Helper to get the resource type from an item that matches the given resource ID

Parameters:

item - The item to check

resourceId - The resource to look for

Returns:

The resource type information or null

validateQuantity

public static void validateQuantity(int quantity)

validateSlotIndex

public static void validateSlotIndex(short slot,
 int capacity)

copy

@Nonnull
public static <T extends ItemContainer> T copy(@Nonnull
 ItemContainer from,
 @Nonnull
 T to,
 @Nullable
 List<ItemStack> remainder)

ensureContainerCapacity

public static <T extends ItemContainer> T ensureContainerCapacity(@Nullable
 T inputContainer,
 short capacity,
 @Nonnull
 com.hypixel.fastutil.shorts.Short2ObjectConcurrentHashMap.ShortFunction<T> newContainerSupplier,
 @Nullable
 List<ItemStack> remainder)

Returns:

a new AbstractItemContainer of size capacity with all the items copied from the inputContainer.

getNewContainer

public static ItemContainer getNewContainer(short capacity,
 @Nonnull
 com.hypixel.fastutil.shorts.Short2ObjectConcurrentHashMap.ShortFunction<ItemContainer> supplier)