Package net.fabricmc.fabric.api.transfer.v1.item

Interface ItemVariant

All Superinterfaces:

TransferVariant<Item>

@NonExtendable
public interface ItemVariant
extends TransferVariant<Item>

An immutable count-less ItemStack, i.e. an immutable association of an item and its data components.

Do not implement, use the static of(...) functions instead.

Field Summary

Fields

Modifier and Type	Field	Description
static final com.mojang.serialization.Codec<ItemVariant>	CODEC
static final PacketCodec<RegistryByteBuf,ItemVariant>	PACKET_CODEC

Method Summary

Modifier and Type	Method	Description
static ItemVariant	blank()	Retrieve a blank ItemVariant.
default Item	getItem()	Return the item of this variant.
default RegistryEntry<Item>	getRegistryEntry()
default boolean	matches(ItemStack stack)	Return true if the item and tag of this variant match those of the passed stack, and false otherwise.
static ItemVariant	of(ItemConvertible item)	Retrieve an ItemVariant with an item and without a tag.
static ItemVariant	of(ItemConvertible item, ComponentChanges components)	Retrieve an ItemVariant with an item and an optional tag.
static ItemVariant	of(ItemStack stack)	Retrieve an ItemVariant with the item and tag of a stack.
default ItemStack	toStack()	Create a new item stack with count 1 from this variant.
default ItemStack	toStack(int count)	Create a new item stack from this variant.

Methods inherited from interface net.fabricmc.fabric.api.transfer.v1.storage.TransferVariant

componentsMatch, getComponents, getObject, hasComponents, isBlank, isOf

Field Details

CODEC

static final com.mojang.serialization.Codec<ItemVariant> CODEC

PACKET_CODEC

static final PacketCodec<RegistryByteBuf,ItemVariant> PACKET_CODEC

Method Details

blank

static ItemVariant blank()

Retrieve a blank ItemVariant.

of

static ItemVariant of(ItemStack stack)

Retrieve an ItemVariant with the item and tag of a stack.

of

static ItemVariant of(ItemConvertible item)

Retrieve an ItemVariant with an item and without a tag.

of

static ItemVariant of(ItemConvertible item,
 ComponentChanges components)

Retrieve an ItemVariant with an item and an optional tag.

matches

default boolean matches(ItemStack stack)

Return true if the item and tag of this variant match those of the passed stack, and false otherwise.

getItem

default Item getItem()

Return the item of this variant.

getRegistryEntry

default RegistryEntry<Item> getRegistryEntry()

toStack

default ItemStack toStack()

Create a new item stack with count 1 from this variant.

toStack

default ItemStack toStack(int count)

Create a new item stack from this variant.

Parameters:

count - The count of the returned stack. It may lead to counts higher than maximum stack size.