Item

Item is an object that can be held in hand. You can use it and can have damage.

NeoForge 26.1.2NeoForge 1.21.1

Step-by-step guide: how to make item →

Fields you fill in

Always edible

Enabling this parameter allows the player to eat the food even in his food bar is full. (eg. Golden Apple)

Animation

Animation is the animation used when the player does an action with the item.

Depending on the item use result, the default arm swing animation may still be played even if

no animation is specified.

Attack speed

This parameter determines how quick the attack cooldown of your item is when attacking entities.

Attribute modifiers

These attribute modifiers are applied to the entity while the item is equipped in the specified slots.

Bind this item to GUI

Select your GUI here to enable inventory and GUI binding on this item.

Set to Empty to disable inventory (you want this in most cases).

Enabling inventory will make this item unstackable.

Open bound GUI on right click

If this parameter is checked or has a condition that returns true,

this item will open the bound GUI on right-click.

Can destroy any block

Check this parameter if you want it to destroy any block with this item or tool, even bedrock.

Charges power based on time used

If checked, the ranged item's projectile power will differ based on how long the ranged item has been charged.

Does item stay in crafting grid when crafted

This parameter controls if the item stays in the crafting grid when crafted.

This means the item will be part of the recipe, but not consumed by it.

Damage item on crafting

If you have enabled "${l10n.t("elementgui.item.container_item")}", you can enable this option to damage the item instead

of simply keeping it in the crafting grid.

Custom property name

This parameter controls the name of this property. Duplicate names are not allowed.

There are some properties defined for all items on behalf of vanilla Minecraft so their names can not be used.

Custom property value

Specify a procedure to determine the value of this custom item property.

If an entity holds this item, the provided coordinates/world describe the location of that entity.

Custom states

Here you can list additional properties of this item and specify how its texture/model changes

depending on given combination of properties' values that form a state.

An item property can take any number (integer or fractional) as its value, so to avoid a need to follow any granularity

and to allow providing close values, a state matches if actual property values extracted from the item are _the same as

or greater than_ expected (specified here) values.

If there are multiple states with matching values, the last of these matching states will be used.

If no states match, the item will use its default visual look.

Along with custom ones, you can also use some built-in item properties defined for all items on behalf of Minecraft.

NOTE: Duplicate states are not allowed. If two or more states only differ in value of single property, then removing

that property will automatically remove duplicates of first of these states.

Attack damage

This parameter determines how much attack damage your item will deal against entities.

Item destroy speed

Destroy speed parameter controls how fast this item destroys the blocks.

Typical values:

  • 1 - normal item
  • 1.5 sword
  • 2> harvesting tool
Enable melee damage

By checking this parameter, you allow your item to become a melee weapon with attack damage and attack speed.

Is this item ranged (shoots projectiles)

By enabling this parameter, the item will become a ranged item

allowing it to shoot a projectile, like bows and crossbows.

For ranged item to work, set the animation to bow or similar

and make sure to use a non-zero value for the item use duration.

If you use the ranged item feature, the item will only shoot

if the required item (ammo) is in the player's inventory. This

is arrows when using vanilla arrows, or the item specified in

the required item parameter of a custom projectile.

If you want to shoot a projectile without the required item system,

use the right click procedure trigger and procedures to shoot it.

Enchantability

How common rare enchantments can be enchanted on this item/tool.

The higher the enchantability, the better enchantments you will get when enchanting the item/tool.

Vanilla values:

  • Wooden tools: 15
  • Stone tools: 5
  • Iron tools: 14
  • Gold tools: 22
  • Diamond tools: 10
  • Netherite tools: 15
  • Books: 1
Every tick while using

This procedure is executed every tick while the item is being used (holding right-click).

This trigger only works if item use duration is more than 0.

Has item glowing effect

Glowing effect makes the item glow like golden apple or enchanted items, except the glow is permanent.

GUI texture

Leave empty to always use the default item model rendering.

When selected, this texture will be shown in GUIs (hotbar, inventories), when dropped,

and in item frames instead of the fully rendered model.

This texture will also override any item property model replacements in GUI

rendering context.

Hand tick

The procedure is executed each tick when the item is held in hand by the player.

Immune to fire

This parameter controls if the item is immune to fire, like Netherite stuff.

Size of inventory (slot count)

Select the number of slots your GUI/inventory has. Don't forget to add 1 to the biggest slot ID.

If the block is bound to GUI, set this value to the biggest slot ID in the GUI + 1

Inventory stack size

This parameter controls maximal size of the stack that can be placed in its internal inventory slots.

Keep in mind that the smaller number between this parameter and max item stack size

determines the actual max stack size.

Inventory tick

This procedure will be executed each tick when the item is inside the inventory of a player.

Is this item a food

Check this box to make this item edible (enable it to have food properties).

Is this food meat

This parameter controls if this food is food for dogs and other animals that eat meat.

Is item a piglin currency

This parameter controls if the item is a piglin currency, like gold ingot.

Item model

Select the model to be used with this item. Model only defines visual look.

  • Normal - Normal item
  • Tool - Model used by tools
  • Custom - you can define custom JSON, JAVA and OBJ models too

When making custom models, JSON is recommended due to vanilla support for this model type.

Model animations list

Here you can specify animations that this item can play and the conditions when animations happen.

**Make sure that animations you use only reference model parts/bones that are present in the model file.

Otherwise, the model may fail to load or the game may crash.**

Animations will only play for the default item model and not for the models from the item states.

Existing model animations specified in the model file or during model file import will also

play alongside animations specified here.

Is this item music disc

When this parameter is enabled, this item can be used in a jukebox and plays the selected song

when inserted into the jukebox. Sound file needs to be in mono OGG Vorbis format.

Jukebox comparator redstone analog output level

Analog redstone value output from the comparator when this music disc is present in the jukebox next to it.

Music disc description

Write the description of your disc. Usually, it's the composer - the name of the music.

Music length in ticks

Length of the music disc in ticks. 20 ticks is one second.

This parameter is used to signal Allays to stop dancing when the number of ticks

specified in this field passes since the start of playback.

Sound to play

Select the music you want the disc plays inside the jukebox.

In order to support all jukebox features such as sound getting more silent with the distance,

make sure your sound is in MONO format.

If you intend to redistribute the mod, make sure you have the permissions to redistribute the music

you use!

Item use count / durability (leave 0 to disable damage)

This parameter controls the durability of the item (how many times the item can be used).

Set this value to 0 to disable use count mechanic on the given item.

Vanilla values for the reference:

  • Gold: 32 uses
  • Wood: 59 uses
  • Stone: 131 uses
  • Iron: 250 uses.
  • Diamond: 1561 uses
  • Netherite: 2031 uses
  • Fishing rod: 64 uses
  • Flint and steel: 64 uses
  • Carrot on a stick: 25 uses
  • Shears: 238 uses
  • Trident: 250 uses
  • Crossbow: 326 uses
  • Shield: 336 uses
  • Bow: 384 uses
  • Elytra: 432 uses
Nutritional value

The nutritional value is how much this food feeds the player.

1 is 1/2 in the food bar. 20 is the full food bar.

On crafted

This procedure is executed when this item is crafted or smelted.

On dropped

This procedure is executed when this item is dropped.

On dropped item entity destroyed

This procedure is executed after a dropped item of this type is destroyed from taking damage (from lava, cacti, etc.)

It is NOT executed when the dropped item despawns.

Projectile to shoot

This is the projectile type this ranged item can shoot.

You can create and use a custom projectile or use a vanilla one. If you select a vanilla projectile,

its values will have higher priority over values specified here.

Disable ammo check

When this parameter is enabled, ranged item shoots even if no projectile is present.

Custom ranged item use condition procedure still applies if selected.

Provided banner patterns

If this list isn't empty, this item can be used in a loom to craft the selected banner patterns.

Ranged use condition

This procedure will be called before the ranged item fires to check if the return value of the selected procedure is

true.

Keep "${l10n.t("condition.common.true")}" to disable any additional conditions. Ammo checks still apply in this case.

Rarity

The rarity affects only the color of the item's name.

  • Common: White
  • Uncommon: Yellow
  • Rare: Aqua
  • Epic: Light Purple
Recipe remainder

This parameter controls the item that will be replaced when used in crafting table.

This means the item will be part of the recipe, but will be replaced with another item.

Result item

This parameter defines what item should be added to inventory of the entity that ate this food.

Saturation

Saturation is the first statistic to decrease when a player performs energy-intensive actions,

and it must be completely depleted before the visible hunger meter begins decreasing.

Shoot constantly when active

If checked, the ranged item will constantly shoot when the player right-clicks it.

Special information

This parameter adds a tooltip to the item when

you hold your icon over the item in your inventory.

If you use a procedure-generated tooltip, and your item is

not held by an entity or currently a dropped item entity,

the entity dependency will be null.

Stack size

This is maximal number of items of this type that can fit in a stack.

Vanilla example: Ender Pearls have a stack size of 16.

Item use duration

This parameter controls how long the item can be used in one take.

If the item is a food, this value will define the time in ticks that the player takes to eat one item of the food.

When entity hit

This procedure is executed when a living entity (cow, creeper, player, etc.) is hit using this item.

When entity swings

Triggers a procedure when the entity swings the item in air.

For example, if you right click on your item in air, the procedure will be executed.

When finish using

This procedure is called after the item has been right-clicked for the entire item use duration.

For example, this procedure is executed after eating a food item.

This trigger only works if item use duration is more than 0.

When right clicked

The procedure is executed when a player right-clicks with this item in his hand.

If you want this procedure to be only called when entity right clicks in the air with this item,

"${l10n.t("elementgui.common.event_right_clicked_block")}" procedure should always return SUCCESS/CONSUME.

When right clicked block

The procedure is executed when the player right-clicks on a block with this item in his hand.

The procedure should return an action result of type SUCCESS/CONSUME if the item interacted with the block,

FAIL if the interaction failed, and PASS if there was no interaction.

If the procedure doesn't return any value, the result action type will be PASS.

If you want the "${l10n.t("elementgui.common.event_right_clicked_air")}" procedure to be only called

when entity right clicks in the air with this item, this procedure should always return SUCCESS/CONSUME.

When stopped using

This procedure is called when the player stops using (releases right click) this item.

This trigger only works if item use duration is more than 0.

When used

When the ranged item is used, the selected procedure will be triggered.