Interface ItemStackSnapshot
- All Superinterfaces:
CopyableDataHolder
,DataHolder
,DataHolder.Immutable<ItemStackSnapshot>
,DataSerializable
,HoverEventSource<HoverEvent.ShowItem>
,SerializableDataHolder
,SerializableDataHolder.Immutable<ItemStackSnapshot>
,ValueContainer
public interface ItemStackSnapshot
extends HoverEventSource<HoverEvent.ShowItem>, SerializableDataHolder.Immutable<ItemStackSnapshot>
Represents a snapshot of an
ItemStack
as an
DataHolder.Immutable
to represent all of the data associated with
the ItemStack
of which the snapshot was created from. Being that
it is a snapshot, a snapshot cannot be modified, but modifications will
result in a new instance of the ItemStackSnapshot
.-
Nested Class Summary
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 TypeMethodDescriptionCreates a newItemStack
with all the data currently available on thisItemStackSnapshot
.static ItemStackSnapshot
empty()
Gets a emptyItemStackSnapshot
.boolean
isEmpty()
Returns true ifquantity()
is zero and therefore this ItemStackSnapshot is empty.int
quantity()
Gets the quantity of items in this theItemStack
thisItemStackSnapshot
is representing.type()
Gets theItemType
of thisItemStackSnapshot
.Methods inherited from interface org.spongepowered.api.data.DataHolder.Immutable
mergeWith, mergeWith, transform, transform, with, with, with, without, without, without
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.Immutable
copy, withRawData
-
Method Details
-
empty
Gets a emptyItemStackSnapshot
.- Returns:
- The empty item stack snapshot
-
type
ItemType type()- Returns:
- The item type
-
quantity
int quantity()Gets the quantity of items in this theItemStack
thisItemStackSnapshot
is representing.- Returns:
- The current stack size
-
isEmpty
boolean isEmpty()Returns true ifquantity()
is zero and therefore this ItemStackSnapshot is empty.- Returns:
- True if this ItemStackSnapshot is empty
-
createStack
ItemStack createStack()Creates a newItemStack
with all the data currently available on thisItemStackSnapshot
.- Returns:
- The newly generated item stack
-