User Tools

Site Tools


ru:tutorial:items

This is an old revision of the document!


Добавление предмета

Введение

Добавление простого предмета - один из первых шагов в создании модов. Вы собираетесь создать объект Предмет, зарегистрировать его и дать ему текстуру. Чтобы добавить дополнительное поведение предмету, вам необходимо сделать ваш собственный класс предмета. В этом и следующих туториалах пространство имён “tutorial” используется как образец, Если у Вас есть отдельное modid - не стесняйтесь использовать его вместо “tutorial”.

Регистрация предмета

Для начала создайте экземпляр предмета. Мы поместим его на верх нашего класса инициализатора. Конструктор принимает в себя образец Item.Settings (или FabricItemSettings), который используется для задания свойств предмета, таких как категория (в творческом меню), прочность и размер стака.

  1. public class ExampleMod implements ModInitializer {
  2.  
  3. // an instance of our new item
  4. public static final Item FABRIC_ITEM = new Item(new FabricItemSettings().group(ItemGroup.MISC));
  5. [...]
  6. }

You'll use the vanilla registry system for registering new content. The basic syntax is Registry#register(Registry Type, Identifier, Content). Registry types are stored as static fields in the Registry class, and the identifier is what labels your content. Content is an instance of whatever you're adding. This can be called anywhere as long as it occurs during initialization.

  1. public class ExampleMod implements ModInitializer {
  2.  
  3. // an instance of our new item
  4. public static final Item FABRIC_ITEM = new Item(new FabricItemSettings().group(ItemGroup.MISC));
  5.  
  6. @Override
  7. public void onInitialize() {
  8. Registry.register(Registry.ITEM, new Identifier("tutorial", "fabric_item"), FABRIC_ITEM);
  9. }
  10. }

Иеперь Ваш предмет добавлен в Minecraft. Нажмите задачу Gradle runClient, чтобы увидеть его в действии

Добавление предмету текстуры

Для регистрации текстуры необходимы .json файл модели и изображение с самой текстурой. Вам нужно поместить их в папку с ресурсами тут:

  Модель предмета: .../resources/assets/tutorial/models/item/fabric_item.json
  Текстура предмета: .../resources/assets/tutorial/textures/item/fabric_item.png

Примеры наших текстур находятся здесь.

Если Вы зарегистрировали Ваш предмет правильно в начале, игра сообщит Вам о том, что не может найти текстуру подобным образом:

  [Server-Worker-1/WARN]: Unable to load model: 'tutorial:fabric_item#inventory' referenced from: tutorial:fabric_item#inventory: java.io.FileNotFoundException: tutorial:models/item/fabric_item.json

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:

{
  "parent": "item/generated",
  "textures": {
    "layer0": "tutorial:item/fabric_item"
  }
}

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. “item/handheld” is used for tools that are held from the bottom left of the texture. textures/layer0 is the location of your image file.

Final textured result:

Creating an Item class

To add additional behavior to the item you will need to create an Item class. The default constructor requires an Item.Settings object.

  1. public class FabricItem extends Item {
  2.  
  3. public FabricItem(Settings settings) {
  4. super(settings);
  5. }
  6. }

A practical use-case for a custom item class would be making the item play a sound when you use it:

  1. public class FabricItem extends Item {
  2.  
  3. public FabricItem(Settings settings) {
  4. super(settings);
  5. }
  6.  
  7. @Override
  8. public TypedActionResult<ItemStack> use(World world, PlayerEntity playerEntity, Hand hand) {
  9. playerEntity.playSound(SoundEvents.BLOCK_WOOL_BREAK, 1.0F, 1.0F);
  10. return TypedActionResult.success(playerEntity.getStackInHand(hand));
  11. }
  12. }

Replace the old Item object with an instance of your new item class:

  1. public class ExampleMod implements ModInitializer {
  2.  
  3. // an instance of our new item
  4. public static final FabricItem FABRIC_ITEM = new FabricItem(new FabricItemSettings().group(ItemGroup.MISC));
  5. [...]
  6. }

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 maxCount(int size) inside FabricItemSettings to specify the max stack size. Note that if your item is damageable you cannot specify a maximum stack size or the game will throw a RuntimeException.

  1. public class ExampleMod implements ModInitializer {
  2.  
  3. // An instance of our new item, where the maximum stack size is 16
  4. public static final FabricItem FABRIC_ITEM = new FabricItem(new FabricItemSettings().group(ItemGroup.MISC).maxCount(16));
  5. [...]
  6. }

Next Steps

ru/tutorial/items.1628703692.txt.gz · Last modified: 2021/08/11 17:41 by vlad_cool