tutorial:items
Differences
This shows you the differences between two versions of the page.
Both sides previous revisionPrevious revisionNext revision | Previous revisionNext revisionBoth sides next revision | ||
tutorial:items [2019/05/20 15:44] – refactoring language draylar | tutorial:items [2022/04/13 07:50] – map2fabricyarn daomephsta | ||
---|---|---|---|
Line 3: | Line 3: | ||
==== Introduction ==== | ==== Introduction ==== | ||
- | One of the first things you'll want to do with Fabric is adding a new item. | + | Adding a basic item is one of the first steps in modding. You're going to need to create an '' |
- | + | ||
- | You're going to need to create an '' | + | |
- | | + | |
==== Registering an Item ==== | ==== Registering an Item ==== | ||
- | First, create an instance of Item. We'll store it at the top of our initializer class. The constructor takes in an Item.Settings object, which is used to set item properties such as the inventory category, durability, and stack count. | + | First, create an instance of <yarn class_1792> |
- | <code java [enable_line_numbers=" | + | <yarncode |
- | public class ExampleMod implements ModInitializer | + | public class ExampleMod implements ModInitializer { |
- | { | + | |
// an instance of our new item | // an instance of our new item | ||
- | public static final Item FABRIC_ITEM = new Item(new Item.Settings().itemGroup(ItemGroup.MISC)); | + | public static final class_1792 |
[...] | [...] | ||
} | } | ||
- | </code> | + | </yarncode> |
- | To register an '' | + | You'll use the vanilla registry system for registering new content. The basic syntax is '' |
- | <code java [enable_line_numbers=" | + | <yarncode |
- | public class ExampleMod implements ModInitializer | + | public class ExampleMod implements ModInitializer { |
- | { | + | |
// an instance of our new item | // an instance of our new item | ||
- | public static final Item FABRIC_ITEM = new Item(new Item.Settings().itemGroup(ItemGroup.MISC)); | + | public static final class_1792 |
- | + | ||
@Override | @Override | ||
- | public void onInitialize() | + | public void onInitialize() { |
- | | + | |
- | | + | } |
- | } | + | |
} | } | ||
- | </code> | + | </yarncode> |
- | Your new item has now been added to Minecraft. Run the `runClient` gradle | + | Your new item has now been added to Minecraft. Run the '' |
{{: | {{: | ||
Line 40: | Line 36: | ||
Registering a texture for an item requires an item model .json file and a texture image. You're going to need to add these to your resource directory. The direct path of each is: | Registering a texture for an item requires an item model .json file and a texture image. You're going to need to add these to your resource directory. The direct path of each is: | ||
- | Item model: .../ | + | Item model: .../ |
- | Item texture: .../ | + | Item texture: .../ |
- | Note that wikitut is your modid. | + | Our example texture can be found [[https:// |
If you registered your item properly in the first step, your game will complain about a missing texture file in a fashion similar to this: | If you registered your item properly in the first step, your game will complain about a missing texture file in a fashion similar to this: | ||
- | [Server-Worker-1/ | + | [Server-Worker-1/ |
It conveniently tells you exactly where it expects your asset[s] to be found-- when in doubt, check the log. | It conveniently tells you exactly where it expects your asset[s] to be found-- when in doubt, check the log. | ||
A basic item model template is: | A basic item model template is: | ||
- | + | <code JavaScript> | |
- | { | + | { |
- | " | + | " |
- | " | + | " |
- | " | + | " |
- | } | + | |
} | } | ||
- | | + | } |
+ | </ | ||
The parent of your item changes how it's rendered in the hand and comes in useful for things like block items in the inventory. " | The parent of your item changes how it's rendered in the hand and comes in useful for things like block items in the inventory. " | ||
Line 68: | Line 64: | ||
To add additional behavior to the item you will need to create an Item class. The default constructor requires an Item.Settings object. | To add additional behavior to the item you will need to create an Item class. The default constructor requires an Item.Settings object. | ||
- | <code java [enable_line_numbers=" | + | <yarncode |
- | public class FabricItem extends | + | public class FabricItem extends |
- | { | + | |
- | public FabricItem(Settings | + | public FabricItem(class_1793 |
- | | + | |
super(settings); | super(settings); | ||
} | } | ||
} | } | ||
- | </code> | + | </yarncode> |
- | An example application | + | A practical use-case for a custom item class would be making the item play a sound when you use it: |
- | <code java [enable_line_numbers=" | + | <yarncode |
- | public class FabricItem extends | + | public class FabricItem extends |
- | { | + | |
- | public FabricItem(Settings | + | public FabricItem(class_1793 |
- | | + | |
super(settings); | super(settings); | ||
} | } | ||
- | | + | |
@Override | @Override | ||
- | public | + | public |
- | | + | playerEntity.method_5783(class_3417.field_14983, 1.0F, 1.0F); |
- | playerEntity.playSound(SoundEvents.BLOCK_WOOL_BREAK, 1.0F, 1.0F); | + | return |
- | return | + | |
} | } | ||
} | } | ||
- | </code> | + | </yarncode> |
+ | |||
+ | Replace the old <yarn class_1792> | ||
+ | < | ||
+ | public class ExampleMod implements ModInitializer { | ||
- | Replace the old Item object with an instance of your new Item: | ||
- | <code java [enable_line_numbers=" | ||
- | public class ExampleMod implements ModInitializer | ||
- | { | ||
// an instance of our new item | // an instance of our new item | ||
- | public static final FabricItem FABRIC_ITEM = new FabricItem(new | + | public static final FabricItem FABRIC_ITEM = new FabricItem(new |
[...] | [...] | ||
} | } | ||
- | </code> | + | </yarncode> |
If you did everything correctly, using the item should now play a sound. | If you did everything correctly, using the item should now play a sound. | ||
+ | |||
+ | ==== What if I want to change the stack size of my item? ==== | ||
+ | |||
+ | For this you would use ''< | ||
+ | < | ||
+ | public class ExampleMod implements ModInitializer { | ||
+ | |||
+ | // An instance of our new item, where the maximum stack size is 16 | ||
+ | public static final FabricItem FABRIC_ITEM = new FabricItem(new FabricItemSettings().method_7892(class_1761.field_7932)).method_7889(16)); | ||
+ | [...] | ||
+ | } | ||
+ | </ | ||
+ | ==== Next Steps ==== | ||
+ | [[tutorial: |
tutorial/items.txt · Last modified: 2024/04/20 08:05 by ryhon