Створення вашого першого предмета 26.2

Дізнайтеся, як зареєструвати простий предмет, як текстурувати, моделювати та називати його.

Ця сторінка познайомить вас з деякими ключовими поняттями, пов’язаними з предметами, а також з тим, як їх можна реєструвати, текстурувати, моделювати та називати.

Якщо ви не знаєте, все в Minecraft зберігається в реєстрах, і предмети не є винятком.

Підготовка класу ID ваших предметів

Почнемо зі створення класу, який містить назву нашого предмета, що зберігається як ResourceKey. ResourceKey містить назву мода, назву предмета та реєстр, до якого він належить.

Ми реалізуємо допоміжний метод, який створює ResourceKey на основі назви предмета; він заповнюватиме решту даних константами, такими як реєстр предмета та ID мода.

Ці посилання на предмет використовуються для генерованих даними теґів предметів.

Ви можете помістити цей метод у клас під назвою ModItemIds (або будь-яку іншу назву класу).

TIP

Mojang також робить це зі своїми предметами! Перегляньте клас ItemIds для натхнення.

public class ModItemIds {
	public static ResourceKey<Item> create(String name) {
		// Create the item key.
		return ResourceKey.create(Registries.ITEM, Identifier.fromNamespaceAndPath(ExampleMod.MOD_ID, name));
	}
}

Клас підготовки предметів

Щоб спростити реєстрацію предметів, можна створити метод, який приймає ключ ресурсів, певні властивості предмета та фабрику для створення екземпляра Item.

Цей метод створить предмет із наданим ключем і зареєструє його в реєстрі предметів гри.

Ви можете помістити цей метод у клас під назвою ModItems (або будь-яку іншу назву класу).

Mojang також робить це зі своїми предметами! Щоб отримати натхнення, перегляньте клас Items.

public class ModItems {
	public static Item register(ResourceKey<Item> itemKey, Function<Item.Properties, Item> itemFactory, Item.Properties settings) {
		// Create the item instance.
		Item item = itemFactory.apply(settings.setId(itemKey));

		// Register the item.
		Registry.register(BuiltInRegistries.ITEM, itemKey, item);

		return item;
	}

}

Зверніть увагу, як ми використовуємо T, загальний тип, який розширює Item. Це дозволяє нам використовувати той самий метод register для реєстрації будь-якого типу предмета, який розширює Item. Ми також використовуємо функцію для фабрики, яка дозволяє нам вказати, як ми хочемо створити наш предмет відповідно до властивостей предмета.

Реєстрація предмета

Тепер ви можете зареєструвати товар за допомогою методу зараз.

Метод реєстратору приймає екземпляр класу Item.Properties як параметр. Цей клас дозволяє вам налаштовувати властивості предмета за допомогою різних методів конструктора.

TIP

Якщо ви хочете змінити розмір стосу свого предмета, ви можете скористатися методом stacksTo у класі Item.Properties.

Це не спрацює, якщо ви позначили предмет як такий, що може бути пошкоджений, оскільки розмір стосу завжди дорівнює 1 для предметів, які можна пошкодити, щоб запобігти повторюваним експлойтам.

public static final ResourceKey<Item> SUSPICIOUS_SUBSTANCE = create("suspicious_substance");

public static final Item SUSPICIOUS_SUBSTANCE = register(ModItemIds.SUSPICIOUS_SUBSTANCE, Item::new, new Item.Properties());

Item::new повідомляє функції реєстратору створити екземпляр Item з Item.Properties шляхом виклику конструктора Item (new Item(...)), який приймає Item.Properties як параметр.

Однак, якщо ви зараз спробуєте запустити модифікований клієнт, ви побачите, що наш предмет ще не існує в грі! Це тому, що ви не ініціалізували клас статично.

Для цього ви можете додати загальнодоступний статичний метод ініціалізації до свого класу та викликати його з класу ініціалізатора мода. Наразі цей метод не потребує нічого всередині.

public static void initialize() {
}

public class ExampleModItems implements ModInitializer {
	@Override
	public void onInitialize() {
		ModItems.initialize();
	}
}

Виклик методу в класі статично ініціалізує його, якщо він не був попередньо завантажений — це означає, що всі static поля оцінюються. Ось для чого цей фіктивний метод initialize.

Додавання предмета до вкладки творчості

INFO

Якщо ви хочете додати предмет до вкладки творчості, перегляньте сторінку власних вкладок творчості для отримання подробиць.

Для прикладу ми додамо цей предмет до інгредієнтів CreativeModeTab, вам потрібно буде використовувати події вкладки творчості Fabric API, зокрема CreativeModeTabEvents.modifyOutputEvent

Це можна зробити за допомогою методу initialize вашого класу предметів.

// Get the event for modifying entries in the ingredients group.
// And register an event handler that adds our suspicious item to the ingredients group.
CreativeModeTabEvents.modifyOutputEvent(CreativeModeTabs.INGREDIENTS)
		.register((creativeTab) -> creativeTab.accept(ModItems.SUSPICIOUS_SUBSTANCE));

Завантажуючись у гру, ви можете побачити, що наш предмет зареєстровано та знаходиться на вкладці «Інгредієнти»:

Однак у ньому відсутнє таке:

• Модель предмета
• Текстура
• Переклад (назва)

Назва предмета

Предмет наразі не має перекладу, тому його потрібно буде додати. Ключ перекладу вже надав Minecraft: item.example-mod.suspicious_substance.

Створіть новий файл JSON у: src/main/resources/assets/example-mod/lang/en_us.json (для української створіть uk_ua.json) і введіть ключ перекладу та його значення:

{
  "item.example-mod.suspicious_substance": "Suspicious Substance"
}

Ви можете перезапустити гру або створити свій мод і натиснути F3+T, щоб застосувати зміни.

Додавання клієнтського предмета, текстури та моделі

Щоб ваш товар мав належний зовнішній вигляд, необхідно:

• Текстура предмета
• Модель предмета
• Клієнтський предмет

Додання текстури

INFO

Для отримання додаткової інформації з цієї теми перегляньте сторінку моделей предметів.

Щоб надати вашому предмету текстуру та модель, просто створіть зображення текстури 16x16 для свого предмета та збережіть його в теці assets/example-mod/textures/item. Назвіть файл текстури так само, як ідентифікатор предмета, але з розширенням .png.

Для прикладу ви можете використовувати цей приклад текстури для suspicious_substance.png

Завантажити Текстура

Додання моделі

Під час перезапуску/перезавантаження гри ви повинні побачити, що предмет все ще не має текстури, тому що вам потрібно буде додати модель, яка використовує цю текстуру.

Ви збираєтеся створити просту модель item/generated, яка приймає вхідну текстуру і нічого більше.

Створіть модель JSON у теці assets/example-mod/models/item з такою самою назвою, як і предмет; suspicious_substance.json

{
  "parent": "minecraft:item/generated",
  "textures": {
    "layer0": "example-mod:item/suspicious_substance"
  }
}

Розбираємо модель JSON

• parent: це батьківська модель, яку ця модель успадкує. У цьому випадку це модель item/generated.
• textures: тут ви визначаєте текстури для моделі. Ключ layer0 — це текстура, яку використовуватиме модель.

Більшість предметів використовуватимуть модель item/generated як батьківську, оскільки це проста модель, яка лише показує текстуру.

Існують альтернативи, такі як item/handheld, який використовується для предметів, які "тримаються" в руці гравця, наприклад інструментів.

Створення клієнтського предмета

Minecraft не визначає автоматично, де можна знайти файли моделей ваших предметів, нам потрібно надати клієнтський предмет.

Створіть JSON клієнтського предмета в assets/example-mod/items з тим же ім’ям файлу, що й ідентифікатор предмета: suspicious_substance.json.

{
  "model": {
    "type": "minecraft:model",
    "model": "example-mod:item/suspicious_substance"
  }
}

Розбір JSON клієнтського предмета

• model: це властивість, яка містить посилання на нашу модель.
  • type: це тип нашої моделі. Для більшості предметів це має бути minecraft:модель
  • model: це ідентифікатор моделі. Він має мати таку форму: example-mod:item/item_name

Тепер ваш предмет у грі має виглядати так:

Зробити предмет компостованим або паливом

Fabric API надає різні реєстри, які можна використовувати для додавання додаткових властивостей до вашого предмета.

Наприклад, якщо ви хочете зробити свій предмет компостованим, ви можете використати CompostableRegistry:

// Add the suspicious substance to the composting registry with a 30% chance of increasing the composter's level.
CompostableRegistry.INSTANCE.add(ModItems.SUSPICIOUS_SUBSTANCE, 0.3f);

Крім того, якщо ви хочете зробити свій предмет паливом, ви можете використати подію FuelValueEvents.BUILD:

// Add the suspicious substance to the registry of fuels, with a burn time of 30 seconds.
// Remember, Minecraft deals with logical based-time using ticks.
// 20 ticks = 1 second.
FuelValueEvents.BUILD.register((builder, context) -> {
	builder.add(ModItems.SUSPICIOUS_SUBSTANCE, 30 * 20);
});

Додання звичайних рецептів майстрування

Якщо ви хочете додати рецепт виготовлення для свого предмета, вам потрібно буде розмістити JSON-файл рецепту в теці data/example-mod/recipe.

Щоб дізнатися більше про формат рецепта, перегляньте ці ресурси:

• Генератор JSON рецептів
• Вікі Minecraft— рецепт JSON

Спеціальні підказки

Якщо ви хочете, щоб ваш предмет мав спеціальну підказку, вам потрібно буде створити клас, який розширює Item і замінює метод appendHoverText. Зауважте, що цей метод застарів, оскільки Mojang працює над тим, щоб поведінка предметів оброблялася виключно через компоненти, а не через предмети — для подробиць див. власні компоненти даних.

INFO

У цьому прикладі використовується клас LightningStick, створений на сторінці власних інтерактивних предметів.

@Override
public void appendHoverText(ItemStack stack, TooltipContext context, TooltipDisplay displayComponent, Consumer<Component> textConsumer, TooltipFlag type) {
	textConsumer.accept(Component.translatable("itemTooltip.example-mod.lightning_stick").withStyle(ChatFormatting.GOLD));
}

Кожен виклик accept() додаватиме один рядок до підказки.