Skip to main content

Module components

Module components 

Source
Expand description

Individual component type definitions.

ModulesΒ§

armor_trim πŸ”’
Vanilla minecraft:trim item component.
attribute_modifiers πŸ”’
Item attribute modifier component.
banner_patterns πŸ”’
Vanilla minecraft:banner_patterns item component.
bees πŸ”’
Vanilla minecraft:bees item component.
block_state πŸ”’
Vanilla minecraft:block_state item component.
blocks_attacks πŸ”’
Vanilla minecraft:blocks_attacks item component.
books πŸ”’
Writable and written book item components.
combat πŸ”’
Combat-related item components.
consumable πŸ”’
Vanilla consumable and death-protection item components.
container_loot πŸ”’
Vanilla minecraft:container_loot item component.
custom_data πŸ”’
Vanilla CustomData item component value.
custom_model_data πŸ”’
Vanilla minecraft:custom_model_data item component.
debug_stick_state πŸ”’
Vanilla minecraft:debug_stick_state item component.
enchantable πŸ”’
Vanilla minecraft:enchantable item component.
enchantments πŸ”’
equippable πŸ”’
Equippable component for armor and equipment items.
fireworks πŸ”’
Vanilla firework explosion and rocket components.
food πŸ”’
Vanilla minecraft:food item component.
instrument πŸ”’
Vanilla minecraft:instrument item component.
item_colors πŸ”’
Vanilla item color and map ID components.
item_lore πŸ”’
Vanilla minecraft:lore item component.
jukebox_playable πŸ”’
Vanilla minecraft:jukebox_playable item component.
kinetic_weapon πŸ”’
Vanilla minecraft:kinetic_weapon item component.
lodestone_tracker πŸ”’
Vanilla minecraft:lodestone_tracker item component.
map_decorations πŸ”’
Vanilla minecraft:map_decorations item component.
map_post_processing πŸ”’
Vanilla minecraft:map_post_processing transient item component.
ominous_bottle_amplifier πŸ”’
Vanilla minecraft:ominous_bottle_amplifier item component.
painting_variant πŸ”’
Vanilla minecraft:painting/variant item component.
pot_decorations πŸ”’
Vanilla minecraft:pot_decorations item component.
potion_contents πŸ”’
Vanilla minecraft:potion_contents item component.
provides_trim_material πŸ”’
Vanilla minecraft:provides_trim_material item component.
rarity πŸ”’
Vanilla minecraft:rarity item component.
recipes πŸ”’
Vanilla minecraft:recipes item component.
recursive_items πŸ”’
Item components whose codecs recursively contain item stack templates.
registry_holder_sets πŸ”’
Components backed by registry holder sets.
rgb_color πŸ”’
Shared codec helpers for Vanilla RGB color components.
suspicious_stew πŸ”’
Vanilla minecraft:suspicious_stew_effects item component.
swing_animation πŸ”’
Vanilla minecraft:swing_animation item component.
tool πŸ”’
Tool component for mining speed and drop behavior.
tooltip_display πŸ”’
Vanilla minecraft:tooltip_display item component.
typed_entity_data πŸ”’
Typed entity and block-entity item component data.
use_cooldown πŸ”’
Vanilla minecraft:use_cooldown item component.
use_effects πŸ”’
Vanilla minecraft:use_effects item component.

StructsΒ§

ArmorTrim
Material and pattern applied to a trimmed equipment item.
AttackRange
BannerPatternLayer
One pattern and color layer on a banner or shield.
BannerPatternLayers
Ordered banner pattern layers.
BeehiveOccupant
One entity stored inside a beehive block item.
Bees
Ordered occupants stored inside a beehive block item.
BlockEntityData
Block-entity type plus custom block-entity data without its redundant id field.
BlockItemStateProperties
String-valued block properties applied when a block item is placed.
BlocksAttacks
Complete blocking behavior configured on an item.
BundleContents
The ordered item templates stored in a bundle.
ChargedProjectiles
The non-empty projectile templates loaded into a crossbow.
Consumable
Use timing, presentation, and post-consumption effects.
CustomData
Immutable component wrapper around a Vanilla-normalized NBT compound.
CustomModelData
Values exposed to item models and tint sources through custom model data.
DamageReduction
One directional damage-reduction rule.
DamageResistant
Damage types that cannot hurt an item stack.
DamageTypeComponent
DeathProtection
Effects applied when an item prevents death.
DebugStickProperty
Selected property for one block in a debug stick.
DebugStickState
Per-block property selections stored by a debug stick.
DyedItemColor
RGB color applied to dyeable items.
Enchantable
Positive value used to perturb enchanting-table levels.
EntityData
Entity type plus custom entity data without its redundant id field.
Equippable
The equippable component data.
Filterable
Raw text paired with the optional server-filtered projection.
FireworkExplosion
Visual data for one firework explosion.
Fireworks
Flight duration and ordered explosions carried by a firework rocket.
FoodProperties
Nutrition restored by consuming an item.
GlobalPos
A block position paired with a dimension resource key.
InstrumentComponent
Instrument selected for an instrument item such as a goat horn.
InvalidEnchantableValue
ItemAttributeModifierEntry
A single item attribute modifier entry.
ItemAttributeModifiers
Vanilla minecraft:attribute_modifiers item component.
ItemContainerContents
Up to 256 dense optional container slots.
ItemDamageFunction
Durability damage applied after blocking an attack.
ItemEnchantments
Enchantments stored on an item. Maps enchantment key to level.
ItemLore
Item lore plus the vanilla display-styled projection of each line.
ItemLoreTooLong
Error returned when lore exceeds vanilla’s 256-line limit.
JukeboxPlayable
A jukebox song attached to an item stack.
KineticWeapon
Data controlling a spear-like continuous kinetic attack.
KineticWeaponCondition
Time and speed thresholds for one kinetic-weapon action.
LodestoneTracker
Optional lodestone target and whether Vanilla should keep validating it.
MapDecorationEntry
One named decoration placed on a map.
MapDecorations
Decorations keyed by their arbitrary map-local IDs.
MapId
Numeric identifier for a map saved-data entry.
MapItemColor
Color used to tint a filled map item.
OminousBottleAmplifier
PaintingVariantComponent
Registry-owned painting variant stored on a painting item.
PiercingWeapon
PotDecorations
The back, left, right, and front decorations of a decorated pot.
PotionContents
A registered base potion plus optional custom display and effect data.
ProvidesTrimMaterial
Trim material supplied by an ingredient in the smithing table.
Recipes
Ordered recipe resource keys carried by knowledge books.
Repairable
Items accepted as repair materials for an item stack.
SeededContainerLoot
Loot-table resource key and optional deterministic seed for a container item.
SulfurCubeContent
The non-empty absorbed block item carried by a sulfur cube.
SuspiciousStewEffect
One effect granted by a suspicious stew.
SuspiciousStewEffects
Ordered effects granted by a suspicious stew.
SwingAnimation
Vanilla swing animation type and duration in ticks.
Tool
Mining speed and drop behavior for an item.
ToolRule
A single rule within a tool component.
TooltipDisplay
Global tooltip visibility and the ordered set of hidden component types.
UseCooldown
Vanilla UseCooldown: seconds plus an optional shared cooldown group.
UseEffects
Controls movement and vibration behavior while an item is being used.
UseRemainder
The item template produced after consuming an item.
Weapon
WritableBookContent
Editable pages in a writable book.
WrittenBookContent
Signed book metadata and rendered pages.

EnumsΒ§

FireworkExplosionShape
Shape rendered by a firework explosion.
ItemAttributeModifierDisplay
Tooltip display behavior for an item attribute modifier.
ItemUseAnimation
Arm animation displayed while using an item.
MapPostProcessing
Operation applied to a filled map after crafting.
Rarity
Vanilla item rarity, including its serialized and network IDs.
SwingAnimationType
Visual animation used when an item is swung.

Type AliasesΒ§

EquippableAllowedEntities
Entity types allowed to equip an item.
ProvidesBannerPatterns
Banner patterns unlocked by an ingredient in the loom.
ToolRuleBlocks
The block holder set used by a tool rule.