import Emoji from ‘@site/src/components/Emoji’; import FileTreeRoot from ‘@site/src/components/FileTree/Root’; import FileTreeNode from ‘@site/src/components/FileTree/Node’;

Custom Items

Custom items tutorial

Using Figura you can make custom items that are visible in first and third person.

You’ll need to use the Item [[../enums/ModelPartParentTypes|keyword]] and the item_render event combined.

Item Keyword

If you give a Blockbench group the Item keyword (by starting the group name with Item) it will be primed and ready to be used as an item. Without the event the Item group will vanish- and so will every item you hold. It has to be Item with a capital I.

Item Render Event

The item_render event runs once a frame for every item you’re rendering and they do their own things in their own version of the event.

In order to make the Item show up you must return it in the item_render event. This example assumes the bbmodel is named model and that the keyworded group is named Item. If you wish to test this change model to your bbmodel name and the Item group to your version.

function events.item_render()

    return models.model.Item

end

This will replace every single item you’re holding with your custom item

Replacing Specific Items

Here’s an exmaple for replacing a single item by id:

function events.item_render(item)

    if item.id == "minecraft:crossbow" then

        return models.model.ItemBow

    end

end

Here’s an exmaple for replacing a single item by name:

function events.item_render(item)

    if item:getName() == "Lightning" then

        return models.model.ItemBow

    end

end

You can use the event’s arguments to get different information from the item you’re holding, and they are: the itemstack, rendering mode, position, rotation, scale, and if its in the left hand. [[../enums/ItemDisplayModes|Possible item rendering modes.]]

function events.item_render(item, mode, pos, rot, scale, left)

end

This is storing all the values you can get, but in most cases you only need item and sometimes mode. Let’s replace bows, shields, and all swords. These are all for a blockbench model that looks like this:

function events.item_render(item)

    if item.id == "minecraft:bow" then

        return models.model.ItemBow

    elseif item.id == "minecraft:shield" then

        return models.model.ItemShield

    elseif item.id:find("sword") then

        return models.model.ItemSword

    end

end

The find function is searching the id for the word ‘sword’ so you don’t need to type in every single sword id. This also makes it compatible with modded swords.

Things To Note

Do not put the Item group inside any other group. The Blockbench outliner should look like this:

or

because you can have more than one of these keywords. Do not nest Item keywords inside another. And, do not have more than one custom item per instance of the Item keyword.

You could put your Item group in another group but be careful, doing so makes it easier to cause unwanted behavior. For example, if you put it into RightArm or LeftArm it will be force unrendered, defeating the point of it.

0,0,0 in Blockbench is where the player will be holding the item in the world