Package io.papermc.paper.datacomponent

Class DataComponentTypes

java.lang.Object

io.papermc.paper.datacomponent.DataComponentTypes

@NullMarked
@Experimental
public final class DataComponentTypes
extends Object

All the different types of data that ItemStacks and ItemTypes can have.

Field Summary

Fields

Modifier and Type	Field	Description
static final DataComponentType.Valued<ItemAttributeModifiers>	ATTRIBUTE_MODIFIERS	Holds attribute modifiers applied to any item, if not set, has an implicit default value based on the item type's default attributes (e.g.
static final DataComponentType.Valued<BannerPatternLayers>	BANNER_PATTERNS	Stores the additional patterns applied to a Banner or Shield.
static final DataComponentType.Valued<DyeColor>	BASE_COLOR	Stores the base color for a Shield.
static final DataComponentType.Valued<BlockItemDataProperties>	BLOCK_DATA	Holds block state properties to apply when placing a block.
static final DataComponentType.Valued<BundleContents>	BUNDLE_CONTENTS	Holds all items stored inside a Bundle.
static final DataComponentType.Valued<ItemAdventurePredicate>	CAN_BREAK	Controls which blocks a player in Adventure mode can break with this item.
static final DataComponentType.Valued<ItemAdventurePredicate>	CAN_PLACE_ON	Controls which blocks a player in Adventure mode can place on with this item.
static final DataComponentType.Valued<ChargedProjectiles>	CHARGED_PROJECTILES	Holds all projectiles that have been loaded into a Crossbow.
static final DataComponentType.Valued<Consumable>	CONSUMABLE
static final DataComponentType.Valued<ItemContainerContents>	CONTAINER	Holds the contents of container blocks (Chests, Shulker Boxes) in item form.
static final DataComponentType.Valued<SeededContainerLoot>	CONTAINER_LOOT	Holds the unresolved loot table and seed of a container-like block.
static final DataComponentType.Valued<CustomModelData>	CUSTOM_MODEL_DATA	Controls the minecraft:custom_model_data property in the item model.
static final DataComponentType.Valued<Component>	CUSTOM_NAME	Custom name override for an item (as set by renaming with an Anvil).
static final DataComponentType.Valued<@NonNegative Integer>	DAMAGE	The amount of durability removed from an item, for damageable items (with the MAX_DAMAGE component), has an implicit default value of: 0.
static final DataComponentType.Valued<DamageResistant>	DAMAGE_RESISTANT	If present, this item will not burn in fire.
static final DataComponentType.Valued<DeathProtection>	DEATH_PROTECTION
static final DataComponentType.Valued<DyedItemColor>	DYED_COLOR	Represents a color applied to a dyeable item (in the ItemTypeTagKeys.DYEABLE item tag).
static final DataComponentType.Valued<Enchantable>	ENCHANTABLE
static final DataComponentType.Valued<Boolean>	ENCHANTMENT_GLINT_OVERRIDE	Overrides the enchantment glint effect on an item.
static final DataComponentType.Valued<ItemEnchantments>	ENCHANTMENTS	Controls the enchantments on an item.
static final DataComponentType.Valued<Equippable>	EQUIPPABLE
static final DataComponentType.Valued<FireworkEffect>	FIREWORK_EXPLOSION	Stores the explosion crafted in a Firework Star.
static final DataComponentType.Valued<Fireworks>	FIREWORKS	Stores all explosions crafted into a Firework Rocket, as well as flight duration.
static final DataComponentType.Valued<FoodProperties>	FOOD	Controls potential food benefits gained when consuming the item the component is applied on.
static final DataComponentType.NonValued	GLIDER
static final DataComponentType.NonValued	HIDE_ADDITIONAL_TOOLTIP	If set, disables 'additional' tooltip part which comes from the item type (e.g.
static final DataComponentType.NonValued	HIDE_TOOLTIP	If set, it will completely hide whole item tooltip (that includes item name).
static final DataComponentType.Valued<MusicInstrument>	INSTRUMENT	Holds the instrument type used by a Goat Horn.
static final DataComponentType.NonValued	INTANGIBLE_PROJECTILE	Marks that a projectile item would be intangible when fired (i.e.
static final DataComponentType.Valued<Key>	ITEM_MODEL
static final DataComponentType.Valued<Component>	ITEM_NAME	When present, replaces default item name with contained chat component.
static final DataComponentType.Valued<JukeboxPlayable>	JUKEBOX_PLAYABLE	List of recipes that should be unlocked when using the Knowledge Book item.
static final DataComponentType.Valued<LodestoneTracker>	LODESTONE_TRACKER	If present, specifies that the Compass is a Lodestone Compass.
static final DataComponentType.Valued<ItemLore>	LORE	Additional lines to include in an item's tooltip.
static final DataComponentType.Valued<MapItemColor>	MAP_COLOR	Represents the tint of the decorations on the ItemType.FILLED_MAP item.
static final DataComponentType.Valued<MapDecorations>	MAP_DECORATIONS	Holds a list of markers to be placed on a ItemType.FILLED_MAP (used for Explorer Maps).
static final DataComponentType.Valued<MapId>	MAP_ID	References the shared map state holding map contents and markers for a ItemType.FILLED_MAP.
static final DataComponentType.Valued<MapPostProcessing>	MAP_POST_PROCESSING	Internal map item state used in the map crafting recipe.
static final DataComponentType.Valued<@Positive Integer>	MAX_DAMAGE	Controls the maximum amount of damage than an item can take, if not present, the item cannot be damaged.
static final DataComponentType.Valued<@IntRange(from=1L,to=99L) Integer>	MAX_STACK_SIZE	Controls the maximum stacking size of this item.
static final DataComponentType.Valued<Key>	NOTE_BLOCK_SOUND	Controls the sound played by a Player Head when placed on a Note Block.
static final DataComponentType.Valued<OminousBottleAmplifier>	OMINOUS_BOTTLE_AMPLIFIER	Controls the amplifier amount for an Ominous Bottle's Bad Omen effect.
static final DataComponentType.Valued<PotDecorations>	POT_DECORATIONS	Stores the Sherds applied to each side of a Decorated Pot.
static final DataComponentType.Valued<PotionContents>	POTION_CONTENTS	Holds the contents of a potion (Potion, Splash Potion, Lingering Potion), or potion applied to a Tipped Arrow.
static final DataComponentType.Valued<ResolvableProfile>	PROFILE	Controls the skin displayed on a Player Head.
static final DataComponentType.Valued<ItemRarity>	RARITY	Controls the color of the item name.
static final DataComponentType.Valued<List<Key>>	RECIPES
static final DataComponentType.Valued<@NonNegative Integer>	REPAIR_COST	The additional experience cost required to modify an item in an Anvil.
static final DataComponentType.Valued<Repairable>	REPAIRABLE
static final DataComponentType.Valued<ItemEnchantments>	STORED_ENCHANTMENTS	Stores list of enchantments and their levels for an Enchanted Book.
static final DataComponentType.Valued<SuspiciousStewEffects>	SUSPICIOUS_STEW_EFFECTS	Holds the effects that will be applied when consuming Suspicious Stew.
static final DataComponentType.Valued<Tool>	TOOL	Controls the behavior of the item as a tool.
static final DataComponentType.Valued<Key>	TOOLTIP_STYLE
static final DataComponentType.Valued<ItemArmorTrim>	TRIM	Holds the trims applied to an item in recipes
static final DataComponentType.Valued<Unbreakable>	UNBREAKABLE	If set, the item will not lose any durability when used.
static final DataComponentType.Valued<UseCooldown>	USE_COOLDOWN
static final DataComponentType.Valued<UseRemainder>	USE_REMAINDER
static final DataComponentType.Valued<WritableBookContent>	WRITABLE_BOOK_CONTENT	Holds the contents in a Book and Quill.
static final DataComponentType.Valued<WrittenBookContent>	WRITTEN_BOOK_CONTENT	Holds the contents and metadata of a Written Book.

Method Summary

Methods inherited from class java.lang.Object

clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

Field Details

MAX_STACK_SIZE

public static final DataComponentType.Valued<@IntRange(from=1L,to=99L) Integer> MAX_STACK_SIZE

Controls the maximum stacking size of this item.
Values greater than 1 are mutually exclusive with the MAX_DAMAGE component.

MAX_DAMAGE

public static final DataComponentType.Valued<@Positive Integer> MAX_DAMAGE

Controls the maximum amount of damage than an item can take, if not present, the item cannot be damaged.
Mutually exclusive with the MAX_STACK_SIZE component greater than 1.

See Also:

• DAMAGE

DAMAGE

public static final DataComponentType.Valued<@NonNegative Integer> DAMAGE

The amount of durability removed from an item, for damageable items (with the MAX_DAMAGE component), has an implicit default value of: 0.

See Also:

• MAX_DAMAGE

UNBREAKABLE

public static final DataComponentType.Valued<Unbreakable> UNBREAKABLE

If set, the item will not lose any durability when used.

CUSTOM_NAME

public static final DataComponentType.Valued<Component> CUSTOM_NAME

Custom name override for an item (as set by renaming with an Anvil).

See Also:

• ITEM_NAME

ITEM_NAME

public static final DataComponentType.Valued<Component> ITEM_NAME

When present, replaces default item name with contained chat component.

Differences from CUSTOM_NAME:

• can't be changed or removed in Anvil
• is not styled with italics when displayed to player
• does not show labels where applicable (for example: banner markers, names in item frames)

See Also:

• CUSTOM_NAME

ITEM_MODEL

public static final DataComponentType.Valued<Key> ITEM_MODEL

LORE

public static final DataComponentType.Valued<ItemLore> LORE

Additional lines to include in an item's tooltip.

RARITY

public static final DataComponentType.Valued<ItemRarity> RARITY

Controls the color of the item name.

ENCHANTMENTS

public static final DataComponentType.Valued<ItemEnchantments> ENCHANTMENTS

Controls the enchantments on an item.
If not present on a non-enchantment book, this item will not work in an anvil.

See Also:

• STORED_ENCHANTMENTS

CAN_PLACE_ON

public static final DataComponentType.Valued<ItemAdventurePredicate> CAN_PLACE_ON

Controls which blocks a player in Adventure mode can place on with this item.

CAN_BREAK

public static final DataComponentType.Valued<ItemAdventurePredicate> CAN_BREAK

Controls which blocks a player in Adventure mode can break with this item.

ATTRIBUTE_MODIFIERS

public static final DataComponentType.Valued<ItemAttributeModifiers> ATTRIBUTE_MODIFIERS

Holds attribute modifiers applied to any item, if not set, has an implicit default value based on the item type's default attributes (e.g. attack damage for weapons).

CUSTOM_MODEL_DATA

public static final DataComponentType.Valued<CustomModelData> CUSTOM_MODEL_DATA

Controls the minecraft:custom_model_data property in the item model.

HIDE_ADDITIONAL_TOOLTIP

public static final DataComponentType.NonValued HIDE_ADDITIONAL_TOOLTIP

If set, disables 'additional' tooltip part which comes from the item type (e.g. content of a shulker).

HIDE_TOOLTIP

public static final DataComponentType.NonValued HIDE_TOOLTIP

If set, it will completely hide whole item tooltip (that includes item name).

REPAIR_COST

public static final DataComponentType.Valued<@NonNegative Integer> REPAIR_COST

The additional experience cost required to modify an item in an Anvil. If not present, has an implicit default value of: 0.

ENCHANTMENT_GLINT_OVERRIDE

public static final DataComponentType.Valued<Boolean> ENCHANTMENT_GLINT_OVERRIDE

Overrides the enchantment glint effect on an item. If not present, default behaviour is used.

INTANGIBLE_PROJECTILE

public static final DataComponentType.NonValued INTANGIBLE_PROJECTILE

Marks that a projectile item would be intangible when fired (i.e. can only be picked up by a creative mode player).

FOOD

public static final DataComponentType.Valued<FoodProperties> FOOD

Controls potential food benefits gained when consuming the item the component is applied on. Requires the CONSUMABLE component to allow consumption in the first place.

CONSUMABLE

public static final DataComponentType.Valued<Consumable> CONSUMABLE

USE_REMAINDER

public static final DataComponentType.Valued<UseRemainder> USE_REMAINDER

USE_COOLDOWN

public static final DataComponentType.Valued<UseCooldown> USE_COOLDOWN

DAMAGE_RESISTANT

public static final DataComponentType.Valued<DamageResistant> DAMAGE_RESISTANT

If present, this item will not burn in fire.

TOOL

public static final DataComponentType.Valued<Tool> TOOL

Controls the behavior of the item as a tool.

ENCHANTABLE

public static final DataComponentType.Valued<Enchantable> ENCHANTABLE

EQUIPPABLE

public static final DataComponentType.Valued<Equippable> EQUIPPABLE

REPAIRABLE

public static final DataComponentType.Valued<Repairable> REPAIRABLE

GLIDER

public static final DataComponentType.NonValued GLIDER

TOOLTIP_STYLE

public static final DataComponentType.Valued<Key> TOOLTIP_STYLE

DEATH_PROTECTION

public static final DataComponentType.Valued<DeathProtection> DEATH_PROTECTION

STORED_ENCHANTMENTS

public static final DataComponentType.Valued<ItemEnchantments> STORED_ENCHANTMENTS

Stores list of enchantments and their levels for an Enchanted Book. Unlike ENCHANTMENTS, the effects provided by enchantments do not apply from this component.
If not present on an Enchanted Book, it will not work in an anvil.

Has an undefined behaviour if present on an item that is not an Enchanted Book (currently the presence of this component allows enchantments from ENCHANTMENTS to be applied as if this item was an Enchanted Book).

See Also:

• ENCHANTMENTS

DYED_COLOR

public static final DataComponentType.Valued<DyedItemColor> DYED_COLOR

Represents a color applied to a dyeable item (in the ItemTypeTagKeys.DYEABLE item tag).

MAP_COLOR

public static final DataComponentType.Valued<MapItemColor> MAP_COLOR

Represents the tint of the decorations on the ItemType.FILLED_MAP item.

MAP_ID

public static final DataComponentType.Valued<MapId> MAP_ID

References the shared map state holding map contents and markers for a ItemType.FILLED_MAP.

MAP_DECORATIONS

public static final DataComponentType.Valued<MapDecorations> MAP_DECORATIONS

Holds a list of markers to be placed on a ItemType.FILLED_MAP (used for Explorer Maps).

MAP_POST_PROCESSING

public static final DataComponentType.Valued<MapPostProcessing> MAP_POST_PROCESSING

Internal map item state used in the map crafting recipe.

CHARGED_PROJECTILES

public static final DataComponentType.Valued<ChargedProjectiles> CHARGED_PROJECTILES

Holds all projectiles that have been loaded into a Crossbow. If not present, the Crossbow is not charged.

BUNDLE_CONTENTS

public static final DataComponentType.Valued<BundleContents> BUNDLE_CONTENTS

Holds all items stored inside a Bundle. If removed, items cannot be added to the Bundle.

POTION_CONTENTS

public static final DataComponentType.Valued<PotionContents> POTION_CONTENTS

Holds the contents of a potion (Potion, Splash Potion, Lingering Potion), or potion applied to a Tipped Arrow.

SUSPICIOUS_STEW_EFFECTS

public static final DataComponentType.Valued<SuspiciousStewEffects> SUSPICIOUS_STEW_EFFECTS

Holds the effects that will be applied when consuming Suspicious Stew.

WRITABLE_BOOK_CONTENT

public static final DataComponentType.Valued<WritableBookContent> WRITABLE_BOOK_CONTENT

Holds the contents in a Book and Quill.

WRITTEN_BOOK_CONTENT

public static final DataComponentType.Valued<WrittenBookContent> WRITTEN_BOOK_CONTENT

Holds the contents and metadata of a Written Book.

TRIM

public static final DataComponentType.Valued<ItemArmorTrim> TRIM

Holds the trims applied to an item in recipes

INSTRUMENT

public static final DataComponentType.Valued<MusicInstrument> INSTRUMENT

Holds the instrument type used by a Goat Horn.

OMINOUS_BOTTLE_AMPLIFIER

public static final DataComponentType.Valued<OminousBottleAmplifier> OMINOUS_BOTTLE_AMPLIFIER

Controls the amplifier amount for an Ominous Bottle's Bad Omen effect.

JUKEBOX_PLAYABLE

public static final DataComponentType.Valued<JukeboxPlayable> JUKEBOX_PLAYABLE

List of recipes that should be unlocked when using the Knowledge Book item.

RECIPES

public static final DataComponentType.Valued<List<Key>> RECIPES

LODESTONE_TRACKER

public static final DataComponentType.Valued<LodestoneTracker> LODESTONE_TRACKER

If present, specifies that the Compass is a Lodestone Compass.

FIREWORK_EXPLOSION

public static final DataComponentType.Valued<FireworkEffect> FIREWORK_EXPLOSION

Stores the explosion crafted in a Firework Star.

FIREWORKS

public static final DataComponentType.Valued<Fireworks> FIREWORKS

Stores all explosions crafted into a Firework Rocket, as well as flight duration.

PROFILE

public static final DataComponentType.Valued<ResolvableProfile> PROFILE

Controls the skin displayed on a Player Head.

NOTE_BLOCK_SOUND

public static final DataComponentType.Valued<Key> NOTE_BLOCK_SOUND

Controls the sound played by a Player Head when placed on a Note Block.

BANNER_PATTERNS

public static final DataComponentType.Valued<BannerPatternLayers> BANNER_PATTERNS

Stores the additional patterns applied to a Banner or Shield.

BASE_COLOR

public static final DataComponentType.Valued<DyeColor> BASE_COLOR

Stores the base color for a Shield.

POT_DECORATIONS

public static final DataComponentType.Valued<PotDecorations> POT_DECORATIONS

Stores the Sherds applied to each side of a Decorated Pot.

CONTAINER

public static final DataComponentType.Valued<ItemContainerContents> CONTAINER

Holds the contents of container blocks (Chests, Shulker Boxes) in item form.

BLOCK_DATA

public static final DataComponentType.Valued<BlockItemDataProperties> BLOCK_DATA

Holds block state properties to apply when placing a block.

CONTAINER_LOOT

public static final DataComponentType.Valued<SeededContainerLoot> CONTAINER_LOOT

Holds the unresolved loot table and seed of a container-like block.