Package org.spongepowered.api.item.inventory

Interface ItemStackLike

All Superinterfaces:

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

All Known Subinterfaces:

ItemStack, ItemStackSnapshot

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

Represents a stack of a specific ItemType. Supports serialization.

ItemStackLike 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/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
ItemStackSnapshot	asImmutable()	Retrieves an immutable form of this ItemStackLike.
ItemStack	asMutable()	Retrieves a mutable form of this ItemStackLike.
ItemStack	asMutableCopy()	Retrieves a copy in the mutable form of this ItemStackLike.
default Collection<AttributeModifier>	attributeModifiers(Supplier<? extends AttributeType> attributeType, EquipmentType equipmentType)	Gets all AttributeModifiers on this ItemStackLike.
default Collection<AttributeModifier>	attributeModifiers(Supplier<? extends AttributeType> attributeType, DefaultedRegistryReference<? extends EquipmentType> equipmentType)	Gets all AttributeModifiers on this ItemStackLike.
Collection<AttributeModifier>	attributeModifiers(AttributeType attributeType, EquipmentType equipmentType)	Gets all AttributeModifiers on this ItemStackLike.
default Collection<AttributeModifier>	attributeModifiers(AttributeType attributeType, DefaultedRegistryReference<? extends EquipmentType> equipmentType)	Gets all AttributeModifiers on this ItemStackLike.
ItemStackLike	copy()	Creates a clone copy of this CopyableDataHolder as a new CopyableDataHolder such that all the Values are safely duplicated to the new instance.
boolean	isEmpty()	Returns true if quantity() is zero and therefore this ItemStackLike is empty.
default int	maxStackQuantity()	Gets the maximum quantity per stack.
int	quantity()	Gets the quantity of items in this stack.
ItemType	type()	Gets the ItemType of this ItemStackLike.

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

asComponent

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.value.ValueContainer

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

Method Details

type

ItemType type()

Gets the ItemType of this ItemStackLike.

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

maxStackQuantity

default 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

isEmpty

boolean isEmpty()

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

In Vanilla empty ItemStacks are not rendered by the client.

Returns:

True if this ItemStackLike is empty

attributeModifiers

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

Gets all AttributeModifiers on this ItemStackLike.

Parameters:

attributeType - The AttributeType of the modifier.

equipmentType - The EquipmentType this modifier is applied. to.

Returns:

A collection of AttributeModifiers.

attributeModifiers

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

Gets all AttributeModifiers on this ItemStackLike.

Parameters:

attributeType - The AttributeType of the modifier.

equipmentType - The EquipmentType this modifier is applied. to.

Returns:

A collection of AttributeModifiers.

attributeModifiers

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

Gets all AttributeModifiers on this ItemStackLike.

Parameters:

attributeType - The AttributeType of the modifier.

equipmentType - The EquipmentType this modifier is applied. to.

Returns:

A collection of AttributeModifiers.

attributeModifiers

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

Gets all AttributeModifiers on this ItemStackLike.

Parameters:

attributeType - The AttributeType of the modifier.

equipmentType - The EquipmentType this modifier is applied. to.

Returns:

A collection of AttributeModifiers.

asMutable

ItemStack asMutable()

Retrieves a mutable form of this ItemStackLike. If this ItemStackLike is already mutable, this would simply return itself. In other cases, a new ItemStack is created with all the data currently available on this ItemStackLike.

Returns:

An ItemStack

asMutableCopy

ItemStack asMutableCopy()

Retrieves a copy in the mutable form of this ItemStackLike. The new ItemStack is created with all the data currently available on this ItemStackLike.

Returns:

A new ItemStack

asImmutable

ItemStackSnapshot asImmutable()

Retrieves an immutable form of this ItemStackLike. If this ItemStackLike is already immutable, this would simply return itself. In other cases, a new ItemStackSnapshot is created with all known Values existing on this ItemStackLike added as copies to the ItemStackSnapshot.

Returns:

An ItemStackSnapshot

copy

ItemStackLike 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

Returns:

The new copy