Package org.spongepowered.api.item.inventory

Interface ItemStack

All Superinterfaces:

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

public interface ItemStack
extends ItemStackLike, SerializableDataHolder.Mutable

Represents mutable ItemStackLike. Can be compared using the comparators listed in ItemStackComparators.

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(Supplier<? extends AttributeType> attributeType, AttributeModifier modifier, EquipmentType equipmentType)	Adds an AttributeModifier to this item stack.
default void	addAttributeModifier(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.
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.
default ItemStackSnapshot	createSnapshot()	Deprecated, for removal: This API element is subject to removal in a future version. Use ItemStackLike.asImmutable() instead.
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.
static ItemStack	of(Supplier<? extends ItemType> itemType)	Creates a new ItemStack of the provided ItemType and quantity of 1
static ItemStack	of(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.
void	setQuantity(int quantity)	Sets the quantity in this stack.

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.item.inventory.ItemStackLike

asImmutable, asMutable, asMutableCopy, attributeModifiers, attributeModifiers, attributeModifiers, attributeModifiers, isEmpty, maxStackQuantity, quantity, type

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 Details

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(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(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

setQuantity

void setQuantity(int quantity)
          throws IllegalArgumentException

Sets the quantity in this stack.

Parameters:

quantity - Quantity

Throws:

IllegalArgumentException - If quantity set exceeds the ItemStackLike.maxStackQuantity()

createSnapshot

@Deprecated(forRemoval=true)
default ItemStackSnapshot createSnapshot()

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

Use ItemStackLike.asImmutable() instead.

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

addAttributeModifier

default void addAttributeModifier(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(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 ItemStackLike

Specified by:

copy in interface SerializableDataHolder

Specified by:

copy in interface SerializableDataHolder.Mutable

Returns:

The new copy