Package org.spongepowered.api.item.inventory

Interface ItemStack

All Superinterfaces:

ComponentLike, CopyableDataHolder, DataHolder, DataHolder.Mutable, DataSerializable, HoverEventSource<HoverEvent.ShowItem>, SerializableDataHolder, SerializableDataHolder.Mutable, ValueContainer

public interface ItemStack
extends SerializableDataHolder.Mutable, ComponentLike, HoverEventSource<HoverEvent.ShowItem>

Represents a stack of a specific ItemType. Supports serialization and can be compared using the comparators listed in ItemStackComparators.

ItemStacks have a variety of properties and data. It is advised to use ValueContainer.get(Key) in order to retrieve information regarding this item stack.

Nested Class Summary

Nested Classes

Modifier and Type	Interface	Description
static interface	ItemStack.Builder
static interface	ItemStack.Factory

Nested classes/interfaces inherited from interface org.spongepowered.api.data.DataHolder

DataHolder.Immutable<I extends DataHolder.Immutable<I>>, DataHolder.Mutable

Nested classes/interfaces inherited from interface org.spongepowered.api.data.SerializableDataHolder

SerializableDataHolder.Immutable<I extends SerializableDataHolder.Immutable<I>>, SerializableDataHolder.Mutable

Method Summary

Modifier and Type	Method	Description
default void	addAttributeModifier(java.util.function.Supplier<? extends AttributeType> attributeType, AttributeModifier modifier, EquipmentType equipmentType)	Adds an AttributeModifier to this item stack.
default void	addAttributeModifier(java.util.function.Supplier<? extends AttributeType> attributeType, AttributeModifier modifier, DefaultedRegistryReference<? extends EquipmentType> equipmentType)	Adds an AttributeModifier to this item stack.
void	addAttributeModifier(AttributeType attributeType, AttributeModifier modifier, EquipmentType equipmentType)	Adds an AttributeModifier to this item stack.
default void	addAttributeModifier(AttributeType attributeType, AttributeModifier modifier, DefaultedRegistryReference<? extends EquipmentType> equipmentType)	Adds an AttributeModifier to this item stack.
default java.util.Collection<AttributeModifier>	attributeModifiers(java.util.function.Supplier<? extends AttributeType> attributeType, EquipmentType equipmentType)	Gets all AttributeModifiers on this item stack.
default java.util.Collection<AttributeModifier>	attributeModifiers(java.util.function.Supplier<? extends AttributeType> attributeType, DefaultedRegistryReference<? extends EquipmentType> equipmentType)	Gets all AttributeModifiers on this item stack.
java.util.Collection<AttributeModifier>	attributeModifiers(AttributeType attributeType, EquipmentType equipmentType)	Gets all AttributeModifiers on this item stack.
default java.util.Collection<AttributeModifier>	attributeModifiers(AttributeType attributeType, DefaultedRegistryReference<? extends EquipmentType> equipmentType)	Gets all AttributeModifiers on this item stack.
static ItemStack.Builder	builder()	Creates a new ItemStack.Builder to build an ItemStack.
ItemStack	copy()	Creates a clone copy of this CopyableDataHolder as a new CopyableDataHolder such that all the Values are safely duplicated to the new instance.
ItemStackSnapshot	createSnapshot()	Gets the ItemStackSnapshot of this ItemStack.
static ItemStack	empty()	Returns an empty ItemStack.
boolean	equalTo(ItemStack that)	Returns true if the specified ItemStack has the same stack size, ItemType, and data.
boolean	isEmpty()	Returns true if quantity() is zero and therefore this ItemStack is empty.
int	maxStackQuantity()	Gets the maximum quantity per stack.
static ItemStack	of(java.util.function.Supplier<? extends ItemType> itemType)	Creates a new ItemStack of the provided ItemType and quantity of 1
static ItemStack	of(java.util.function.Supplier<? extends ItemType> itemType, int quantity)	Creates a new ItemStack of the provided ItemType and quantity.
static ItemStack	of(ItemType itemType)	Creates a new ItemStack of the provided ItemType and quantity of 1
static ItemStack	of(ItemType itemType, int quantity)	Creates a new ItemStack of the provided ItemType and quantity.
int	quantity()	Gets the quantity of items in this stack.
void	setQuantity(int quantity)	Sets the quantity in this stack.
ItemType	type()	Gets the ItemType of this ItemStack.

Methods inherited from interface net.kyori.adventure.text.ComponentLike

asComponent

Methods inherited from interface org.spongepowered.api.data.DataHolder.Mutable

copyFrom, copyFrom, offer, offer, offer, offer, offerAll, offerAll, offerAll, offerAll, offerAll, offerAll, offerSingle, offerSingle, offerSingle, offerSingle, remove, remove, remove, removeAll, removeAll, removeAll, removeAll, removeAll, removeAll, removeKey, removeKey, removeSingle, removeSingle, transform, transform, tryOffer, tryOffer, tryOffer, undo

Methods inherited from interface org.spongepowered.api.data.persistence.DataSerializable

contentVersion, toContainer

Methods inherited from interface net.kyori.adventure.text.event.HoverEventSource

asHoverEvent, asHoverEvent

Methods inherited from interface org.spongepowered.api.data.SerializableDataHolder

validateRawData

Methods inherited from interface org.spongepowered.api.data.SerializableDataHolder.Mutable

setRawData

Methods inherited from interface org.spongepowered.api.data.value.ValueContainer

get, getDouble, getInt, getKeys, getLong, getOrElse, getOrNull, getValue, getValues, require, requireValue, supports, supports

Method Detail

empty

static ItemStack empty()

Returns an empty ItemStack.

Returns:

The empty ItemStack

builder

static ItemStack.Builder builder()

Creates a new ItemStack.Builder to build an ItemStack.

Returns:

The new builder

of

static ItemStack of(java.util.function.Supplier<? extends ItemType> itemType,
                    int quantity)

Creates a new ItemStack of the provided ItemType and quantity.

Parameters:

itemType - The item type

quantity - The quantity

Returns:

The new item stack

of

static ItemStack of(ItemType itemType,
                    int quantity)

Creates a new ItemStack of the provided ItemType and quantity.

Parameters:

itemType - The item type

quantity - The quantity

Returns:

The new item stack

of

static ItemStack of(java.util.function.Supplier<? extends ItemType> itemType)

Creates a new ItemStack of the provided ItemType and quantity of 1

Parameters:

itemType - The item type

Returns:

The new item stack

of

static ItemStack of(ItemType itemType)

Creates a new ItemStack of the provided ItemType and quantity of 1

Parameters:

itemType - The item type

Returns:

The new item stack

type

ItemType type()

Gets the ItemType of this ItemStack.

Returns:

The item type

quantity

int quantity()

Gets the quantity of items in this stack. This may exceed the max stack size of the item, and if added to an inventory will then be divided by the max stack.

Returns:

Quantity of items

setQuantity

void setQuantity(int quantity)
          throws java.lang.IllegalArgumentException

Sets the quantity in this stack.

Parameters:

quantity - Quantity

Throws:

java.lang.IllegalArgumentException - If quantity set exceeds the maxStackQuantity()

maxStackQuantity

int maxStackQuantity()

Gets the maximum quantity per stack. By default, returns ItemType.maxStackQuantity(), unless a different value has been set for this specific stack.

Returns:

Max stack quantity

createSnapshot

ItemStackSnapshot createSnapshot()

Gets the ItemStackSnapshot of this ItemStack. All known Values existing on this ItemStack are added as copies to the ItemStackSnapshot.

Returns:

The newly created item stack snapshot

equalTo

boolean equalTo(ItemStack that)

Returns true if the specified ItemStack has the same stack size, ItemType, and data. Note that this method is not an overrider of Object.equals(Object) in order to maintain compatibility with the base game. Therefore, ItemStacks may not behave as expected when using them in equality based constructs such as Maps or Sets.

Parameters:

that - ItemStack to compare

Returns:

True if this equals the ItemStack

isEmpty

boolean isEmpty()

Returns true if quantity() is zero and therefore this ItemStack is empty.

In Vanilla empty ItemStacks are not rendered by the client.

Returns:

True if this ItemStack is empty

attributeModifiers

default java.util.Collection<AttributeModifier> attributeModifiers(java.util.function.Supplier<? extends AttributeType> attributeType,
                                                                   DefaultedRegistryReference<? extends EquipmentType> equipmentType)

Gets all AttributeModifiers on this item stack.

Parameters:

attributeType - The AttributeType of the modifier.

equipmentType - The EquipmentType this modifier is applied to.

Returns:

A collection of AttributeModifiers.

attributeModifiers

default java.util.Collection<AttributeModifier> attributeModifiers(AttributeType attributeType,
                                                                   DefaultedRegistryReference<? extends EquipmentType> equipmentType)

Gets all AttributeModifiers on this item stack.

Parameters:

attributeType - The AttributeType of the modifier.

equipmentType - The EquipmentType this modifier is applied to.

Returns:

A collection of AttributeModifiers.

attributeModifiers

default java.util.Collection<AttributeModifier> attributeModifiers(java.util.function.Supplier<? extends AttributeType> attributeType,
                                                                   EquipmentType equipmentType)

Gets all AttributeModifiers on this item stack.

Parameters:

attributeType - The AttributeType of the modifier.

equipmentType - The EquipmentType this modifier is applied to.

Returns:

A collection of AttributeModifiers.

attributeModifiers

java.util.Collection<AttributeModifier> attributeModifiers(AttributeType attributeType,
                                                           EquipmentType equipmentType)

Gets all AttributeModifiers on this item stack.

Parameters:

attributeType - The AttributeType of the modifier.

equipmentType - The EquipmentType this modifier is applied to.

Returns:

A collection of AttributeModifiers.

addAttributeModifier

default void addAttributeModifier(java.util.function.Supplier<? extends AttributeType> attributeType,
                                  AttributeModifier modifier,
                                  EquipmentType equipmentType)

Adds an AttributeModifier to this item stack.

Parameters:

attributeType - The attribute type.

modifier - The attribute modifier.

equipmentType - The equipment type this modifier will apply under.

addAttributeModifier

default void addAttributeModifier(AttributeType attributeType,
                                  AttributeModifier modifier,
                                  DefaultedRegistryReference<? extends EquipmentType> equipmentType)

Adds an AttributeModifier to this item stack.

Parameters:

attributeType - The attribute type.

modifier - The attribute modifier.

equipmentType - The equipment type this modifier will apply under.

addAttributeModifier

default void addAttributeModifier(java.util.function.Supplier<? extends AttributeType> attributeType,
                                  AttributeModifier modifier,
                                  DefaultedRegistryReference<? extends EquipmentType> equipmentType)

Adds an AttributeModifier to this item stack.

Parameters:

attributeType - The attribute type.

modifier - The attribute modifier.

equipmentType - The equipment type this modifier will apply under.

addAttributeModifier

void addAttributeModifier(AttributeType attributeType,
                          AttributeModifier modifier,
                          EquipmentType equipmentType)

Adds an AttributeModifier to this item stack.

Parameters:

attributeType - The attribute type.

modifier - The attribute modifier.

equipmentType - The equipment type this modifier will apply under.

copy

ItemStack copy()

Description copied from interface: CopyableDataHolder

Creates a clone copy of this CopyableDataHolder as a new CopyableDataHolder such that all the Values are safely duplicated to the new instance. It is not guaranteed that the returning container is of the same type as this container.

Specified by:

copy in interface CopyableDataHolder

Specified by:

copy in interface SerializableDataHolder

Specified by:

copy in interface SerializableDataHolder.Mutable

Returns:

The new copy