ITEM DOCUMENTATION
Version: 1.17.30.20

This is documentation for a beta release of Minecraft. New features, components, and capabilities in this release are not final and might change without notice before the final release.
Be sure to check the documentation once the release is out of beta if your add-on isn't working properly. Resource and Behavior Packs created for the beta are not guaranteed to work on the final release.

Index

Items
Item Components
Item Definition Properties
Item Description Properties

Items

To define an item, the item definition must be defined in the behavior pack in a JSON file.
All attributes, including item names, must be defined using item components.

Item Components

Below are the various components for item functionality.

Name	Type	Description
minecraft:armor	JSON Object	The armor item component determines the amount of protection you have in your armor item. Experimental toggles required: Holiday Creator Features protection How much protection does the armor item have. Minimum value: 0 Type: integer Back to top texture_type Texture Type to apply for the armor. Note that Horse armor is restricted to leather, iron, gold, or diamond. Accepted values: "gold", "none", "leather", "chain", "iron", "diamond", "elytra", "turtle", "netherite" Back to top
minecraft:block_placer	JSON Object	Planter item component. planter items are items that can be planted. Experimental toggles required: Holiday Creator Features block block: Set the placement block name for the planter item. Type: block_legacy_ptr Back to top use_on List of block descriptors that contain blocks that this item can be used on. If left empty, all blocks will be allowed. Type: array of block_descriptor Back to top
minecraft:cooldown	JSON Object	Cool down time for a component. After you use an item it becomes unusable for the duration specified by the 'cool down time' setting in this component. Experimental toggles required: Holiday Creator Features category The type of cool down for this item. Type: string Back to top duration The duration of time this item will spend cooling down before becoming usable again. Type: float Back to top
minecraft:digger	JSON Object	Digger item. Component put on items that dig. Experimental toggles required: Holiday Creator Features destroy_speeds Destroy speed per block. Type: array of destroy_speeds Back to top on_dig Trigger for when you dig a block that isn't listed in destroy_speeds Type: trigger Back to top use_efficiency Use efficiency? Default is set to false. Type: boolean Back to top
minecraft:display_name	JSON Object	Display Name item component. Display Names set the name to display when an item is in use or hovered over. Experimental toggles required: Holiday Creator Features value The display name for an item. Type: description_id_setter Back to top
minecraft:durability	JSON Object	Durability item component: how much damage can this item take before breaking. Experimental toggles required: Holiday Creator Features damage_chance Damage chance. Type: damage_chance Back to top max_durability Max durability is the amount of damage that this item can take before breaking. Type: integer Back to top
minecraft:dye_powder	JSON Object	Dye powder, there are 16 kinds of dye. Experimental toggles required: Holiday Creator Features color Defines what color the dye is. Accepted values: "black", "red", "green", "brown", "blue", "purple", "cyan", "silver", "gray", "pink", "lime", "yellow", "lightblue", "magenta", "orange", "white" Back to top
minecraft:entity_placer	JSON Object	Entity placer item component. You can specifiy allowed blocks that the item is restricted to. Experimental toggles required: Holiday Creator Features dispense_on List of block descriptors that contain blocks that this item can be dispensed on. If left empty, all blocks will be allowed. Type: array of block_descriptor Back to top entity The entity to be placed in the world. Type: actor_definition_identifier Back to top use_on List of block descriptors that contain blocks that this item can be used on. If left empty, all blocks will be allowed. Type: array of block_descriptor Back to top
minecraft:food	JSON Object	When an item has a food component, it becomes edible to the player. Experimental toggles required: Holiday Creator Features can_always_eat If true you can always eat this item (even when not hungry), defaults to false. Type: boolean Back to top nutrition How much nutrition does this food item give the player when eaten. Type: integer Back to top on_consume Type: trigger Back to top saturation_modifier Saturation Modifier is used in this formula: (nutrition * saturation_modifier * 2) when appling the saturation buff. Which happens when you eat the item. Type: saturation_modifier_node Back to top using_converts_to When used, convert the this item to the one specified by 'using_converts_to'. Type: item_descriptor Back to top
minecraft:fuel	JSON Object	Fuel component. Allows this item to be used as fuel in a furnace to 'cook' other items. Experimental toggles required: Holiday Creator Features duration How long in seconds will this fuel cook items for. Type: float Back to top
minecraft:icon	JSON Object	The icon item componenent determines the icon to represent the item in the UI and elsewhere. Experimental toggles required: Holiday Creator Features frame An index or expression for which frame of the icon to display. Default resolves to 0. Type: expression_node Back to top legacy_id Legacy texture id for older item icons Type: string Back to top texture The key from the resource_pack/textures/item_texture.json 'texture_data' object associated with the texture file Example: blaze_powder Type: string Back to top
minecraft:knockback_resistance	JSON Object	Knockback Resistance Item. Component put on items that provide knockback resistance. Experimental toggles required: Holiday Creator Features protection Amount of knockback resistance provided with the total maximum protection being 1.0 Type: float Back to top
minecraft:on_use	JSON Object	The on_use item component allows you to receive an event when the item is used. Experimental toggles required: Holiday Creator Features on_use Event trigger for when the item is used. Type: trigger Back to top
minecraft:on_use_on	JSON Object	The on_use_on item component allows you to receive an event when the item is used on a block in the world. Experimental toggles required: Holiday Creator Features on_use_on Event trigger for when the item is used. Type: trigger Back to top
minecraft:projectile	JSON Object	Projectile item component. projectile items shoot out, like an arrow. Experimental toggles required: Holiday Creator Features minimum_critical_power How long you must charge a projectile for it to critically hit. Type: float Back to top projectile_entity The entity to be fired as a projectile. Type: actor_definition_identifier Back to top
minecraft:render_offsets	JSON Object	Render offsets component: optional values can be given to offset the way the item is rendered. Experimental toggles required: Holiday Creator Features main_hand Main hand transform data. Type: item_transforms Back to top off_hand Offhand hand transform data. Type: item_transforms Back to top
minecraft:repairable	JSON Object	Repairable item component: how much damage can this item repair, what items can repair it. Experimental toggles required: Holiday Creator Features on_repaired Event that is called when this item has been repaired. Type: trigger Back to top repair_items Repair item entries. Type: array of repair_items Back to top
minecraft:shooter	JSON Object	Shooter Item Component. Experimental toggles required: Holiday Creator Features ammunition Ammunition. Type: array of ammunition Back to top charge_on_draw Charge on draw? Default is set to false. Type: boolean Back to top launch_power_scale Launch power scale. Default is set to 1.0. Type: float Back to top max_draw_duration Draw Duration. Default is set to 0. Type: draw_duration_node Back to top max_launch_power Launch power. Default is set to 1.0. Type: float Back to top scale_power_by_draw_duration Scale power by draw duration? Default is set to false. Type: boolean Back to top
minecraft:throwable	JSON Object	Throwable item component. Throwable items, such as a snowball. Experimental toggles required: Holiday Creator Features do_swing_animation Whether the item should use the swing animation when thrown. Default is set to false. Type: boolean Back to top launch_power_scale The scale at which the power of the throw increases. Default is set to 1.0. Type: float Back to top max_draw_duration The maximum duration to draw a throwable item. Default is set to 0.0. Type: float Back to top max_launch_power The maximum power to launch the throwable item. Default is set to 1.0. Type: float Back to top min_draw_duration The minimum duration to draw a throwable item. Default is set to 0.0. Type: float Back to top scale_power_by_draw_duration Whether or not the power of the throw increases with duration charged. Default is set to false. Type: boolean Back to top
minecraft:weapon	JSON Object	Weapon Item Component. Added to every weapon item such as axe, sword, trident, bow, crossbow. Experimental toggles required: Holiday Creator Features on_hit_block Trigger for letting you know when this item is used to hit a block Type: trigger Back to top on_hurt_entity Trigger for letting you know when this item is used to hurt another mob Type: trigger Back to top on_not_hurt_entity Trigger for letting you know when this item hit another actor, but didn't do damage Type: trigger Back to top
minecraft:wearable	JSON Object	Wearable item component. Experimental toggles required: Holiday Creator Features slot equipment_slot: slot.weapon.mainhand, slot.weapon.offhand, slot.armor.head, slot.armor.chest, slot.armor.legs, slot.armor.feet, slot.hotbar, slot.inventory, slot.enderchest, slot.saddle, slot.armor, slot.chest Accepted values: "slot.armor.legs", "none", "slot.weapon.mainhand", "slot.weapon.offhand", "slot.armor.head", "slot.armor.chest", "slot.armor.feet", "slot.hotbar", "slot.inventory", "slot.enderchest", "slot.saddle", "slot.armor", "slot.chest" Back to top

Item Definition Properties

The properties are part of the Item Definition. This helps the system determine how to parse and initialize this item.

format_version

Specifies the version of the game this entity was made in. If the version is lower than the current version, any changes made to the entity in the vanilla version will be applied to it.
Back to top

Code Example

Example

{
  "format_version": "1.16.1",
  "minecraft:item": {
    "description": {
      "identifier": "minecraft:blaze_rod"
    },
    "components": {
      "minecraft:fuel": {
        "duration": 120.0
      },
      "minecraft:max_stack_size": 64,
      "minecraft:icon": {
        "texture": "blaze_rod"
      },
      "minecraft:hand_equipped": true,
      "minecraft:display_name": {
        "value": "Blaze Rod"
      }
    }
  }
}

Item Description Properties

Name	Type	Default Value	Description
category	String		The category for this item. Categories are used to control high level properties of how the item is integrated into the bedrock engine, such as whether it can be used in slash commands.
identifier	String		The identifier for this item. The name must include a namespace and must not use the Minecraft namespace unless overriding a Vanilla item.
is_experimental	Boolean	false	If this item is experimental, it will only be registered if the world is marked as experimental.

ITEM DOCUMENTATION Version: 1.17.30.20

Index

Items

Item Components

protection

texture_type

block

use_on

category

duration

destroy_speeds

on_dig

use_efficiency

value

damage_chance

max_durability

color

dispense_on

entity

use_on

can_always_eat

nutrition

on_consume

saturation_modifier

using_converts_to

duration

frame

legacy_id

texture

protection

on_use

on_use_on

minimum_critical_power

projectile_entity

main_hand

off_hand

on_repaired

repair_items

ammunition

charge_on_draw

launch_power_scale

max_draw_duration

max_launch_power

scale_power_by_draw_duration

do_swing_animation

launch_power_scale

max_draw_duration

max_launch_power

min_draw_duration

scale_power_by_draw_duration

on_hit_block

on_hurt_entity

on_not_hurt_entity

slot

Item Definition Properties

format_version

Code Example

Item Description Properties

ITEM DOCUMENTATION
Version: 1.17.30.20