Minecraft:Java Edition protocol/Slot data: Difference between revisions
More actions
Sync: updated from Minecraft |
Sync: updated from Minecraft |
||
| Line 471: | Line 471: | ||
| {{Type|Prefixed Optional}} {{Type|Identifier}} | | {{Type|Prefixed Optional}} {{Type|Identifier}} | ||
| Group of items to apply the cooldown to. If absent defaults to the item's identifier. | | Group of items to apply the cooldown to. If absent defaults to the item's identifier. | ||
|} | |||
|- | |||
| <code>minecraft:use_effects</code> | |||
| | |||
| As follows: | |||
{| class="wikitable" | |||
! Name | |||
! Type | |||
! Description | |||
|- | |||
| Can Sprint | |||
| {{Type|Boolean}} | |||
| | |||
|- | |||
| Interact Vibrations | |||
| {{Type|Boolean}} | |||
| | |||
|- | |||
| Speed Multiplier | |||
| {{Type|Float}} | |||
| | |||
|} | |||
|- | |||
| <code>minecraft:minimum_attack_charge</code> | |||
| | |||
| As follows: | |||
{| class="wikitable" | |||
! Name | |||
! Type | |||
! Description | |||
|- | |||
| Minimum Attack Change | |||
| {{Type|Float}} | |||
| | |||
|} | |||
|- | |||
| <code>minecraft:damage_type</code> | |||
| Type of damage dealt by the item in melee. | |||
| As follows: | |||
{| class="wikitable" | |||
! Name | |||
! Type | |||
! Description | |||
|- | |||
| Damage Type | |||
| {{Type|VarInt}} | |||
| ID in the <code>minecraft:damage_type</code> | |||
|} | |} | ||
|- | |- | ||
| Line 482: | Line 529: | ||
|- | |- | ||
| Types | | Types | ||
| {{Type| | | {{Type|ID Set}} | ||
| | | Damage types the item is immune to. | ||
|} | |||
|- | |||
| <code>minecraft:attack_range</code> | |||
| | |||
| As follows: | |||
{| class="wikitable" | |||
! Name | |||
! Type | |||
! Description | |||
|- | |||
| Min Reach | |||
| {{Type|Float}} | |||
| | |||
|- | |||
| Max Reach | |||
| {{Type|Float}} | |||
| | |||
|- | |||
| Min Creative Reach | |||
| {{Type|Float}} | |||
| | |||
|- | |||
| Max Creative Reach | |||
| {{Type|Float}} | |||
| | |||
|- | |||
| Hitbox Margin | |||
| {{Type|Float}} | |||
| | |||
|- | |||
| Mob Factor | |||
| {{Type|Float}} | |||
| | |||
|} | |} | ||
|- | |- | ||
| Line 690: | Line 770: | ||
|- | |- | ||
| colspan="2"| Bypassed by | | colspan="2"| Bypassed by | ||
| colspan="2"| {{Type|Prefixed Optional}} {{Type| | | colspan="2"| {{Type|Prefixed Optional}} {{Type|ID Set}} | ||
| IDs in the <code>minecraft:damage_type</code> registry. | |||
|- | |- | ||
| colspan="2"| Block sound | | colspan="2"| Block sound | ||
| Line 1,017: | Line 1,097: | ||
| {{Type|ID or}} [[#Instrument|Instrument]] | | {{Type|ID or}} [[#Instrument|Instrument]] | ||
| ID in the <code>minecraft:instrument</code> registry, or an inline definition. | | ID in the <code>minecraft:instrument</code> registry, or an inline definition. | ||
|} | |||
|- | |||
| <code>minecraft:piercing_weapon</code> | |||
| | |||
| As follows: | |||
{| class="wikitable" | |||
! Name | |||
! Type | |||
! Description | |||
|- | |||
| Deals Knockback | |||
| {{Type|Boolean}} | |||
| | |||
|- | |||
| Dismounts | |||
| {{Type|Boolean}} | |||
| | |||
|- | |||
| Sound | |||
| {{Type|Optional}} {{Type|Sound Event}} | |||
| | |||
|- | |||
| Hit Sound | |||
| {{Type|Optional}} {{Type|Sound Event}} | |||
| | |||
|} | |||
|- | |||
| <code>minecraft:kinetic_weapon</code> | |||
| | |||
| As follows: | |||
{| class="wikitable" | |||
! Name | |||
! Type | |||
! Description | |||
|- | |||
| Contact Cooldown Ticks | |||
| {{Type|VarInt}} | |||
| | |||
|- | |||
| Delay Ticks | |||
| {{Type|VarInt}} | |||
| | |||
|- | |||
| Dismount Conditions | |||
| {{Type|Optional}} [[#Kinetic Weapon Conditions|Kinetic Weapon Conditions]] | |||
| | |||
|- | |||
| Knockback Conditions | |||
| {{Type|Optional}} [[#Kinetic Weapon Conditions|Kinetic Weapon Conditions]] | |||
| | |||
|- | |||
| Damage Conditions | |||
| {{Type|Optional}} [[#Kinetic Weapon Conditions|Kinetic Weapon Conditions]] | |||
| | |||
|- | |||
| Forward Movement | |||
| {{Type|Float}} | |||
| | |||
|- | |||
| Damage Multiplier | |||
| {{Type|Float}} | |||
| | |||
|- | |||
| Sound | |||
| {{Type|Optional}} {{Type|Sound Event}} | |||
| | |||
|- | |||
| Hit Sound | |||
| {{Type|Optional}} {{Type|Sound Event}} | |||
| | |||
|} | |||
|- | |||
| <code>minecraft:swing_animation</code> | |||
| | |||
| As follows: | |||
{| class="wikitable" | |||
! Name | |||
! Type | |||
! Description | |||
|- | |||
| Type | |||
| {{Type|VarInt}} {{Type|Enum}} | |||
| 0: none, 1: whack, 2: stab | |||
|- | |||
| Duration | |||
| {{Type|VarInt}} | |||
| | |||
|} | |||
|- | |||
| <code>minecraft:additional_trade_cost</code> | |||
| | |||
| As follows: | |||
{| class="wikitable" | |||
! Name | |||
! Type | |||
! Description | |||
|- | |||
| Additional Trade Cost | |||
| {{Type|VarInt}} | |||
| | |||
|} | |||
|- | |||
| <code>minecraft:dye</code> | |||
| Makes the item act like a dye in some contexts. | |||
| As follows: | |||
{| class="wikitable" | |||
! Name | |||
! Type | |||
! Description | |||
|- | |||
| Color | |||
| [[#Dye_Color|Dye Color]] | |||
|} | |} | ||
|- | |- | ||
| Line 1,026: | Line 1,218: | ||
! Type | ! Type | ||
! Description | ! Description | ||
|- | |- | ||
| Material | | Material | ||
| {{Type|ID or}} [[#Trim Material|Trim Material]] | |||
| An ID in the <code>minecraft:trim_material</code> registry or a direct trim material definition. | |||
|} | |} | ||
|- | |- | ||
| Line 1,069: | Line 1,244: | ||
! Type | ! Type | ||
! Description | ! Description | ||
|- | |- | ||
| Jukebox Song | | Jukebox Song | ||
| {{Type|ID or}} [[#Jukebox Song|Jukebox Song]] | |||
| ID in the <code>minecraft:jukebox_song</code> registry or a direct jukebox song. | |||
|} | |} | ||
|- | |- | ||
| Line 1,101: | Line 1,259: | ||
|- | |- | ||
| Key | | Key | ||
| {{Type| | | {{Type|ID Set}} | ||
| | | IDs in the <code>minecraft:banner_pattern</code> registry. | ||
|} | |} | ||
|- | |- | ||
| Line 1,340: | Line 1,498: | ||
| {{Type|ID or}} {{Type|Sound Event}} | | {{Type|ID or}} {{Type|Sound Event}} | ||
| ID in the <code>minecraft:sound_event</code> registry, or an inline definition. | | ID in the <code>minecraft:sound_event</code> registry, or an inline definition. | ||
|} | |||
|- | |||
| <code>minecraft:sulfur_cube_content</code> | |||
| The item contained in a sulfur cube. | |||
| As follows: | |||
{| class="wikitable" | |||
! Name | |||
! Type | |||
! Description | |||
|- | |||
| Content | |||
| {{Type|Slot}} | |||
| | |||
|} | |} | ||
|- | |- | ||
| Line 1,503: | Line 1,674: | ||
| {{Type|VarInt}} {{Type|Enum}} | | {{Type|VarInt}} {{Type|Enum}} | ||
| An ID in the <code>minecraft:pig_variant</code> registry. | | An ID in the <code>minecraft:pig_variant</code> registry. | ||
|} | |||
|- | |||
| <code>minecraft:pig/sound_variant</code> | |||
| The type of sounds that a pig makes. | |||
| As follows: | |||
{| class="wikitable" | |||
! Name | |||
! Type | |||
! Description | |||
|- | |||
| Variant | |||
| {{Type|VarInt}} | |||
| An ID in the <code>minecraft:pig_sound_variant</code> registry. | |||
|} | |} | ||
|- | |- | ||
| Line 1,516: | Line 1,700: | ||
| {{Type|VarInt}} {{Type|Enum}} | | {{Type|VarInt}} {{Type|Enum}} | ||
| An ID in the <code>minecraft:cow_variant</code> registry. | | An ID in the <code>minecraft:cow_variant</code> registry. | ||
|} | |||
|- | |||
| <code>minecraft:cow/sound_variant</code> | |||
| The type of sounds that a cow makes. | |||
| As follows: | |||
{| class="wikitable" | |||
! Name | |||
! Type | |||
! Description | |||
|- | |||
| Variant | |||
| {{Type|VarInt}} | |||
| An ID in the <code>minecraft:cow_sound_variant</code> registry. | |||
|} | |} | ||
|- | |- | ||
| Line 1,526: | Line 1,723: | ||
! Description | ! Description | ||
|- | |- | ||
| | | Variant | ||
| {{Type| | | {{Type|VarInt}} | ||
| An ID in the <code>minecraft:chicken_variant</code> registry. | |||
|} | |||
|- | |||
| <code>minecraft:chicken/sound_variant</code> | |||
| The type of sounds that a chicken makes. | |||
| As follows: | |||
{| class="wikitable" | |||
! Name | |||
! Type | |||
! Description | |||
|- | |- | ||
| Variant | | Variant | ||
| {{Type|VarInt}} | |||
| An ID in the <code>minecraft:chicken_sound_variant</code> registry. | |||
|} | |} | ||
|- | |- | ||
| Line 1,609: | Line 1,802: | ||
| {{Type|VarInt}} {{Type|Enum}} | | {{Type|VarInt}} {{Type|Enum}} | ||
| 0: lucy, 1: wild, 2: gold, 3: cyan, 4: blue. | | 0: lucy, 1: wild, 2: gold, 3: cyan, 4: blue. | ||
|} | |||
|- | |||
| <code>minecraft:zombie_nautilus/variant</code> | |||
| The variant of a zombie nautilus. | |||
| As follows: | |||
{| class="wikitable" | |||
! Name | |||
! Type | |||
! Description | |||
|- | |||
| Variant | |||
| {{Type|VarInt}} | |||
| An ID in the <code>minecraft:zombie_nautilus_variant</code> registry. | |||
|} | |} | ||
|- | |- | ||
| Line 1,622: | Line 1,828: | ||
| {{Type|VarInt}} {{Type|Enum}} | | {{Type|VarInt}} {{Type|Enum}} | ||
| An ID in the <code>minecraft:cat_variant</code> registry. | | An ID in the <code>minecraft:cat_variant</code> registry. | ||
|} | |||
|- | |||
| <code>minecraft:cat/sound_variant</code> | |||
| The type of sounds that a cat makes. | |||
| As follows: | |||
{| class="wikitable" | |||
! Name | |||
! Type | |||
! Description | |||
|- | |||
| Variant | |||
| {{Type|VarInt}} | |||
| An ID in the <code>minecraft:cat_sound_variant</code> registry. | |||
|} | |} | ||
|- | |- | ||
Revision as of 11:09, 7 July 2026
The Slot data structure defines how an item is represented when inside an inventory window of any kind, such as a chest or furnace.
This page presents the new Slot data structure, using structured components. You can find the documentation of the old structure, that utilizes raw NBT data, here.
Format
| Name | Type | Meaning | |||
|---|---|---|---|---|---|
| Item Count | Template:Type | The item count. Every following field is only present if this value is greater than zero. | |||
| Item ID | Template:Type Template:Type | ID in the minecraft:item registry. Item IDs are distinct from block IDs; see Data Generators for more information.
| |||
| Number of components to add | Template:Type Template:Type | Number of elements present in the first data component array | |||
| Number of components to remove | Template:Type Template:Type | Number of elements present in the second data component array. This serve as a way to remove the default component values that are present on some items. | |||
| Components to add | Component type | Template:Type Template:Type | Template:Type Template:Type | ID in the minecraft:data_component_type registry, indicating the type of the component and the format of data to follow.
| |
| Component data | Varies | The component-dependent data. See structured components for more detail. | |||
| Components to remove | Component type | Template:Type Template:Type | Template:Type Template:Type | ID in the minecraft:data_component_type registry, indicating the type of the component.
| |
Hashed format
Similar to the usual slot format, but with the notable difference that data component values are encoded as CRC32C (note: CRC32C is not the same thing as CRC32) checksums. The way the checksum is generated is currently undocumented. It's currently only used in the click container packet.
| Name | Type | Meaning | |||
|---|---|---|---|---|---|
| Has Item | Template:Type | Every following field is only present if this value is true. | |||
| Item ID | Template:Type Template:Type | ID in the minecraft:item registry. Item IDs are distinct from block IDs; see Data Generators for more information.
| |||
| Item Count | Template:Type Template:Type | The item count. | |||
| Components to add | Component type | Template:Type Template:Type | Template:Type Template:Type | ID in the minecraft:data_component_type registry, indicating the type of the component.
| |
| Component data hash | Template:Type | A CRC32C (note: CRC32C is not the same thing as CRC32) checksum of the component data. Currently undocumented. | |||
| Components to remove | Component type | Template:Type Template:Type | Template:Type Template:Type | ID in the minecraft:data_component_type registry, indicating the type of the component.
| |
Structured components
The complete list of available components is described below.
For a more in-depth description, and information on how the items below are encoded with the NBT format, see Minecraft:Data component format.
| Name | Description | Data | |||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|
minecraft:custom_data
|
Customizable data that doesn't fit any specific component. | As follows:
| |||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
minecraft:max_stack_size
|
Maximum stack size for the item. | As follows:
| |||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
minecraft:max_damage
|
The maximum damage the item can take before breaking. | As follows:
| |||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
minecraft:damage
|
The current damage of the item. | As follows:
| |||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
minecraft:unbreakable
|
Marks the item as unbreakable. | no fields | |||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
minecraft:custom_name
|
Item's custom name. Normally shown in italic, and changeable at an anvil. |
As follows:
| |||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
minecraft:item_name
|
Override for the item's default name. Shown when the item has no custom name. |
As follows:
| |||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
minecraft:item_model
|
Item's model. | As follows:
| |||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
minecraft:lore
|
Item's lore. | As follows:
| |||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
minecraft:rarity
|
Item's rarity. This affects the default color of the item's name. |
As follows:
| |||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
minecraft:enchantments
|
The enchantments of the item. | As follows:
| |||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
minecraft:can_place_on
|
List of blocks this block can be placed on when in adventure mode. | As follows:
| |||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
minecraft:can_break
|
List of blocks this item can break when in adventure mode. | As follows:
| |||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
minecraft:attribute_modifiers
|
The attribute modifiers of the item. | As follows:
| |||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
minecraft:custom_model_data
|
Value for the item predicate when using custom item models. More info can be found here. |
As follows:
| |||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
minecraft:tooltip_display
|
Allows you to hide all or parts of the item tooltip. | As follows:
| |||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
minecraft:repair_cost
|
Accumulated anvil usage cost. The client displays "Too Expensive" if the value is greater than 40 and the player is not in creative mode (more specifically, if they don't have the insta-build flag enabled). This behavior can be overridden by setting the level with the Set Container Property packet. |
As follows:
| |||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
minecraft:creative_slot_lock
|
Marks the item as non-interactive on the creative inventory (the first 5 rows of items). This is used internally by the client on the paper icon in the saved hot-bars tab. |
no fields | |||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
minecraft:enchantment_glint_override
|
Overrides the item glint resulted from enchantments | As follows:
| |||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
minecraft:intangible_projectile
|
Marks the projectile as intangible (cannot be picked-up). | As follows:
| |||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
minecraft:food
|
Makes the item restore the player's hunger bar when consumed. | As follows:
| |||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
minecraft:consumable
|
Makes the item consumable. | As follows:
| |||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
minecraft:use_remainder
|
This specifies the item produced after using the current item. In the Notchian server, this is used for stews, which turn into bowls. | As follows:
| |||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
minecraft:use_cooldown
|
Cooldown to apply on use of the item. | As follows:
| |||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
minecraft:use_effects
|
As follows:
| ||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
minecraft:minimum_attack_charge
|
As follows:
| ||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
minecraft:damage_type
|
Type of damage dealt by the item in melee. | As follows:
| |||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
minecraft:damage_resistant
|
Marks this item as damage resistant. The client won't render the item as being on-fire if this component is present. |
As follows:
| |||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
minecraft:attack_range
|
As follows:
| ||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
minecraft:tool
|
Alters the speed at which this item breaks certain blocks | As follows:
| |||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
minecraft:weapon
|
Item treated as a weapon | As follows:
| |||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
minecraft:enchantable
|
Allows the item to be enchanted by an enchanting table. | As follows:
| |||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
minecraft:equippable
|
Allows the item to be equipped by the player. | As follows:
| |||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
minecraft:repairable
|
Items that can be combined with this item in an anvil to repair it. | As follows:
| |||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
minecraft:glider
|
Makes the item function like elytra. | no fields | |||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
minecraft:tooltip_style
|
Custom textures for the item tooltip. | As follows:
| |||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
minecraft:death_protection
|
Makes the item function like a totem of undying. | As follows:
| |||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
minecraft:blocks_attacks
|
Makes the item act like a shield. | As follows:
| |||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
minecraft:stored_enchantments
|
The enchantments stored in this enchanted book. | As follows:
| |||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
minecraft:dyed_color
|
Color of dyed leather armor. | As follows:
| |||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
minecraft:map_color
|
Color of the markings on the map item model. | As follows:
| |||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
minecraft:map_id
|
The ID of the map. | As follows:
| |||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
minecraft:map_decorations
|
Icons present on a map. | As follows:
| |||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
minecraft:map_post_processing
|
Used internally by the client when expanding or locking a map. Display extra information on the item's tooltip when the component is present. | As follows:
| |||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
minecraft:charged_projectiles
|
Projectiles loaded into a charged crossbow. | As follows:
| |||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
minecraft:bundle_contents
|
Contents of a bundle. | As follows:
| |||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
minecraft:potion_contents
|
Visual and effects of a potion item. | As follows:
| |||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
minecraft:potion_duration_scale
|
A duration multiplier for items that also have the minecraft:potion_contents component.
|
As follows:
| |||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
minecraft:suspicious_stew_effects
|
Effects granted by a suspicious stew. | As follows:
| |||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
minecraft:writable_book_content
|
Content of a writable book. | As follows:
| |||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
minecraft:written_book_content
|
Content of a written and signed book. | As follows:
| |||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
minecraft:trim
|
Armor's trim pattern and color | As follows:
| |||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
minecraft:debug_stick_state
|
State of the debug stick | As follows:
| |||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
minecraft:entity_data
|
Data for the entity to be created from this item. | As follows:
| |||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
minecraft:bucket_entity_data
|
Data of the entity contained in this bucket. | As follows:
| |||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
minecraft:block_entity_data
|
Data of the block entity to be created from this item. | As follows:
| |||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
minecraft:instrument
|
The sound played when using a goat horn. | As follows:
| |||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
minecraft:piercing_weapon
|
As follows:
| ||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
minecraft:kinetic_weapon
|
As follows:
| ||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
minecraft:swing_animation
|
As follows:
| ||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
minecraft:additional_trade_cost
|
As follows:
| ||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
minecraft:dye
|
Makes the item act like a dye in some contexts. | As follows:
| |||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
minecraft:provides_trim_material
|
Used to make an item into a valid armor trim material. | As follows:
| |||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
minecraft:ominous_bottle_amplifier
|
Amplifier for the effect of an ominous bottle. | As follows:
| |||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
minecraft:jukebox_playable
|
The song this item will play when inserted into a jukebox. Template:Warning |
As follows:
| |||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
minecraft:provides_banner_patterns
|
Used to make an item into a valid banner pattern material. | As follows:
| |||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
minecraft:recipes
|
The recipes this knowledge book unlocks. | As follows:
| |||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
minecraft:lodestone_tracker
|
The lodestone this compass points to. | As follows:
| |||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
minecraft:firework_explosion
|
Properties of a firework star. | As follows:
| |||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
minecraft:fireworks
|
Properties of a firework. | As follows:
| |||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
minecraft:profile
|
Game Profile of a player's head. | As follows:
| |||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
minecraft:note_block_sound
|
Sound played by a note block when this player's head is placed on top of it. | As follows:
| |||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
minecraft:banner_patterns
|
Patterns of a banner or banner applied to a shield. | As follows:
| |||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
minecraft:base_color
|
Base color of the banner applied to a shield. | As follows:
| |||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
minecraft:pot_decorations
|
Decorations on the four sides of a pot. | As follows:
| |||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
minecraft:container
|
Items inside a container of any type. | As follows:
| |||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
minecraft:block_state
|
State of a block. | As follows:
| |||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
minecraft:bees
|
Bees inside a hive. | As follows:
| |||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
minecraft:lock
|
Name of the necessary key to open this container. | As follows:
| |||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
minecraft:container_loot
|
Loot table for an unopened container. | As follows:
| |||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
minecraft:break_sound
|
Changes the sound that plays when the item breaks. | As follows:
| |||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
minecraft:sulfur_cube_content
|
The item contained in a sulfur cube. | As follows:
| |||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
minecraft:villager/variant
|
The biome variant of a villager. | As follows:
| |||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
minecraft:wolf/variant
|
The variant of a wolf. | As follows:
| |||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
minecraft:wolf/sound_variant
|
The type of sounds that a wolf makes. | As follows:
| |||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
minecraft:wolf/collar
|
The dye color of the wolf's collar. | As follows:
| |||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
minecraft:fox/variant
|
The variant of a fox. | As follows:
| |||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
minecraft:salmon/size
|
The size of a salmon. | As follows:
| |||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
minecraft:parrot/variant
|
The variant of a parrot. | As follows:
| |||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
minecraft:tropical_fish/pattern
|
The pattern of a tropical fish. | As follows:
| |||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
minecraft:tropical_fish/base_color
|
The base color of a tropical fish. | As follows:
| |||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
minecraft:tropical_fish/pattern_color
|
The pattern color of a tropical fish. | As follows:
| |||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
minecraft:mooshroom/variant
|
The variant of a mooshroom. | As follows:
| |||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
minecraft:rabbit/variant
|
The variant of a rabbit. | As follows:
| |||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
minecraft:pig/variant
|
The variant of a pig. | As follows:
| |||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
minecraft:pig/sound_variant
|
The type of sounds that a pig makes. | As follows:
| |||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
minecraft:cow/variant
|
The variant of a cow. | As follows:
| |||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
minecraft:cow/sound_variant
|
The type of sounds that a cow makes. | As follows:
| |||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
minecraft:chicken/variant
|
The variant of a chicken. | As follows:
| |||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
minecraft:chicken/sound_variant
|
The type of sounds that a chicken makes. | As follows:
| |||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
minecraft:frog/variant
|
The variant of a frog. | As follows:
| |||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
minecraft:horse/variant
|
The variant of a horse. | As follows:
| |||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
minecraft:painting/variant
|
The variant of a painting. | As follows:
| |||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
minecraft:llama/variant
|
The variant of a llama. | As follows:
| |||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
minecraft:axolotl/variant
|
The variant of an axolotl. | As follows:
| |||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
minecraft:zombie_nautilus/variant
|
The variant of a zombie nautilus. | As follows:
| |||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
minecraft:cat/variant
|
The variant of a cat. | As follows:
| |||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
minecraft:cat/sound_variant
|
The type of sounds that a cat makes. | As follows:
| |||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
minecraft:cat/collar
|
The dye color of the cat's collar. | As follows:
| |||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
minecraft:sheep/color
|
The color of a sheep. | As follows:
| |||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
minecraft:shulker/color
|
The color of a shulker. | As follows:
| |||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
Other types
Common types used in multiple components are described below.
Block Predicate
Describes a predicate used when block filtering is necessary. It can be parameterized to account for any combination of the type of block, the values of specific block state properties, or block entities' NBT data or data components.
| Name | Type | Description |
|---|---|---|
| Blocks | Template:Type Template:Type | IDs in the minecraft:block registry. Present only when tied to specific types of blocks.
|
| Properties | Template:Type Template:Type of Property | See Property structure below. Present only when tied to specific properties of blocks. |
| NBT | Template:Type Template:Type | |
| Data Components | Template:Type of Exact Data Component Matcher | A list of data components which must exactly match the target block. |
| Partial Data Component Predicates | Template:Type of Partial Data Component Matcher | A list of predicates to match the block's data components. Max length = 64. |
Property
| Name | Type | Description |
|---|---|---|
| Name | Template:Type | Name of the block state property. |
| Is Exact Match | Template:Type | Whether this is an exact value match, as opposed to ranged. |
| Exact Value | Template:Type Template:Type | Value of the block state property. Only present in exact match mode. |
| Min Value | Template:Type Template:Type | Minimum value of the block state property range. Only present in ranged match mode. |
| Max Value | Template:Type Template:Type | Maximum value of the block state property range. Only present in ranged match mode. |
Exact Data Component Matcher
| Name | Type | Description |
|---|---|---|
| Type | Template:Type Template:Type | ID of the data component as listed in the table of data component types above. |
| Value | Structured Component | Value of the data component. |
Partial Data Component Matcher
| Name | Type | Description |
|---|---|---|
| Type | Template:Type Template:Type | Type of predicate. 0: damage, 1: enchantments, 2: stored_enchantments, 3: potion_contents, 4: custom_data, 5: container, 6: bundle_contents, 7: firework_explosion, 8: fireworks, 9: writable_book_content, 10: written_book_content, 11: attribute_modifiers, 12: trim, 13: jukebox_playable. |
| Predicate | Template:Type Compound | Minecraft:Data component predicate encoded as an NBT compound tag. |
Dye Color
A color from one of the 16 dye types.
| Name | Type | Description |
|---|---|---|
| Color | Template:Type Template:Type | Can be one of the following:
|
Firework Explosion
Represents a firework explosion, consisting of a shape, colors, and extra details.
| Name | Type | Description |
|---|---|---|
| Shape | Template:Type Template:Type | Can be one of the following:
|
| Colors | Template:Type of Template:Type | The RGB components of the color, encoded as an integer. |
| Fade Colors | Template:Type of Template:Type | The RGB components of the color, encoded as an integer. |
| Has Trail | Template:Type | |
| Has Twinkle | Template:Type |
Potion Effect
Describes all the aspects of a potion effect.
| Name | Type | Description |
|---|---|---|
| Type ID | Template:Type Template:Type | The ID of the effect in the minecraft:mob_effect registry.
|
| Details | Detail | See Detail structure below. |
The Detail structure is defined as follows:
| Name | Type | Description |
|---|---|---|
| Amplifier | Template:Type | |
| Duration | Template:Type | -1 for infinite. |
| Ambient | Template:Type | Produces more translucent particle effects if true. |
| Show Particles | Template:Type | Completely hides effect particles if false. |
| Show Icon | Template:Type | Shows the potion icon in the inventory screen if true. |
| Hidden Effect | Template:Type Detail | Used to store the state of the previous potion effect when a stronger one is applied. This guarantees that the weaker one will persist, in case it lasts longer. |
Trim Material
| Name | Type | Description | ||
|---|---|---|---|---|
| Suffix | Template:Type | |||
| Overrides | Armor Material Type | Template:Type | Template:Type | |
| Overriden Asset Name | Template:Type | |||
| Description | Template:Type | |||
Trim Pattern
| Name | Type | Description |
|---|---|---|
| Asset Name | Template:Type | |
| Template Item | Template:Type | |
| Description | Template:Type | |
| Decal | Template:Type |
Consume Effect
| Name | Type | Description |
|---|---|---|
| Type | Template:Type | The ID of the effect in the minecraft:consume_effect_type registry.
|
| Data | Varies | See below |
| Type | Name | Data | |||||||||
|---|---|---|---|---|---|---|---|---|---|---|---|
| 0 | minecraft:apply_effects
|
| |||||||||
| 1 | minecraft:remove_effects
|
| |||||||||
| 2 | minecraft:clear_all_effects
|
no fields | |||||||||
| 3 | minecraft:teleport_randomly
|
| |||||||||
| 4 | minecraft:play_sound
|
|
Instrument
| Name | Type | Description |
|---|---|---|
| Sound Event | Template:Type Template:Type | The sound to be played. |
| Use Duration | Template:Type | The time it takes to use the instrument. |
| Range | Template:Type | The sound range of the instrument. |
| Description | Template:Type | Description shown in the item tooltip. |
Jukebox Song
| Name | Type | Description |
|---|---|---|
| Sound Event | Template:Type Template:Type | The sound to be played. |
| Description | Template:Type | The description shown in the item lore. |
| Duration | Template:Type | The duration the songs should play for, in seconds. |
| Output | Template:Type | The output strength given by a comparator. Between 0 and 15. |
Banner Pattern
| Name | Type | Description |
|---|---|---|
| Asset ID | Template:Type | Identifier of the asset. |
| Translation Key | Template:Type |