Custom Item API

Custom Item API предоставляет инструменты для разработки уникальных игровых объектов, позволяя администраторам и разработчикам расширять визуальный и функциональный контент сервера.

Custom Item API — это библиотека (API), предназначенная для интеграции в серверные плагины на платформе Paper. Она позволяет разработчикам создавать уникальные предметы и блоки, расширяя стандартный функционал игры без необходимости использования сторонних модов.

Проект предлагает два основных подхода к созданию объектов: использование структуры данных (Data driven) и прямое программное создание через API.

Для создания предметов и блоков через JSON необходимо сформировать структуру пака, аналогичную датапаку или ресурспаку. Файловая структура выглядит следующим образом:

- <namespace>
   - blocks
      - default_block
      - transparent_block
   - items

Пространство имен (namespace) определяет префикс идентификатора объекта в команде /give namespace:item_id. Файлы в папке items становятся ID предметов, а файлы в папках blocks — ID блоков.

Для прозрачных блоков используйте папку transparent_block. Рекомендуется устанавливать в качестве placed_block прозрачный блок, чтобы избежать визуальных искажений.

Для активации пака его нужно поместить в директорию плагина по пути: plugins/Custom_Item_Api/packs.

Разработчики могут динамически регистрировать объекты в коде. Это позволяет задавать сложные действия при взаимодействии с предметом или блоком.

Предмет создается с помощью конструктора new CustomItem(Material material, NamespacedKey key, Class actions). Параметр actions принимает класс, реализующий CustomItemActions, который определяет поведение при клике.

NamespacedKey itemKey = new NamespacedKey(plugin, "example_item");
CustomItem customItem = new CustomItem(Material.FURNACE, itemKey, Class.forName("org.super_man2006.custom_item_api.utils.items.EmptyCustomItemAction"));
customItem.setCustomBlock(blockKey);
customItem.setName(Component.text("Example"));

Блоки создаются через new CustomBlock(Material material, NamespacedKey key, Class actions, Material placedBlock). Действия при установке, разрушении или клике определяются классом, реализующим CustomBlockActions.

Важно: блок использует текстуру предмета, а не текстуру блока. Это означает, что изменение custom_model_data (cmd) позволяет менять внешний вид объекта.

NamespacedKey blockKey = new NamespacedKey(plugin, "example_block");
CustomBlock customBlock = new CustomBlock(Material.FURNACE, blockKey, Class.forName("org.super_man2006.custom_item_api.utils.blocks.EmptyCustomBlockAction"), Material.STONE);
customBlock.setRotation(CustomBlock.Rotation.AROUND_Y);

Для настройки выпадения предмета после разрушения кастомного блока используется метод setDropItem(NamespacedKey).