BackpackAPI — различия между версиями

 
Строка 135: Строка 135:
 
});</syntaxhighlight>
 
});</syntaxhighlight>
 
<div class="mw-parser-output"><div class="mw-parser-output">
 
<div class="mw-parser-output"><div class="mw-parser-output">
=== Остальные методы ''BackpackRegistry'' ===
+
<div class="mw-parser-output">
 
+
=== &nbsp; ===
{| border="1" cellpadding="1" cellspacing="1" style="width: 1000px;"
+
</div>
|-
 
| style="text-align: center; width: 200px;" | Название
 
| style="text-align: center; width: 200px;" | Аргументы
 
| style="text-align: center;" | Описание
 
|-
 
| style="text-align: center;" | '''openGuiFor'''
 
| style="text-align: center;" | item, notUpdateData
 
| Открывает интерфейс рюкзака. Если&nbsp;''notUpdateData&nbsp;''равен false и для переданной даты не заригестрирован контейнер, в руку игрока будет установлен новый предмет. Возвращает дату, которая может отличаться от переданной
 
|-
 
| style="text-align: center;" | '''isBackpack'''
 
| style="text-align: center;" | id
 
| Возвращает истину, если предмет с переданным айди - рюкзак
 
|-
 
| style="text-align: center;" | '''addSlotsToGui'''
 
| style="text-align: center;" | gui, slots, isValidFunc, inRow, center, x, y
 
| Технический метод добавляет слотов в объект интерфейса
 
|}
 
</div> </div> </div> </div> </div> </div> </div> </div></div>
 

Текущая версия на 20:45, 15 октября 2020

BackpackAPI - библиотека, позволяющая создавать рюкзаки.

Загрузка[править]

Версия Ссылка Список изменений Дата релиза
LATEST Скачать   -
8 Скачать   15.05.20
7 Скачать   24.04.20
6 Скачать Добавлена поддержка сохранения id контейнера в extra data 21.04.20
5 Скачать Исправлены баги, оптимизация кода 16.10.19
4 Скачать Исправлены баги 11.09.19
3 Скачать

Новые свойства - items, title

10.09.19
1 Скачать Первая версия 09.03.18

Условия использования[править]

  • Запрещено распространение на сторонних источниках без указания ссылки на официальное сообщество
  • Запрещено изменение кода библиотеки
  • Запрещено явное копирование кода в другие библиотеки или моды 

Используя данный продукт вы автоматически соглашаетесь с этими правилами

Документация[править]

Для регистрации рюкзака необходимо использовать метод register из объекта BackpackRegistry, импортируемый из библиотеки

IMPORT("BackpackAPI");

IDRegistry.genItemID("backpackTest");
Item.createItem("backpackTest", "Test Backpack", {name: "backpackMiners", meta: 0}, {stack: 1});

BackpackRegistry.register(ItemID.backpackTest, {
    title: "My Backpack",
    slots: 80,
    slotsCenter: true,
    inRow: 10,
    items: [
        "^ore.+",
        "^ingot.+",
        1
        {id: 345, data: "^[1-3]$"}
    ]
});

Первым аргумент - айди предмета, при клике которым будет открываться интерфейс рюкзака. Второй - объект, который может содержать следующие поля:

  • title - заголовок окна
  • slots - количество слотов в рюкзаки
  • inRow - количество слотов в ряду
  • slotsCenter - центрировать ли слоты по ширине
  • kind - определяет способ хранения уникального айди рюкзака. Может иметь значения BackpackKind.EXTRA и BackpackKind.META. Если установить первое значение, айди будет находиться в поле "__backpack_id" экстры, второе - в метаданных предмета
  • items- массив предметов, которые можно положить в рюкзак. Описывается регулярными выражениями, айди или объектом с айди и датой (причем оба свойства могут быть заданы регуляркой)

В объекте можно объявить метод isValidItem(id, data, count), если он возвращает истину предмет перемещается в слот. Если его нет, будет задан стандартный, который разрешает перемещение всех предметов, описанных в массиве items, кроме других рюкзаков. В данном примере можно положить только камень:

BackpackRegistry.register(ItemID.backpackTest, {
    slots: 20,
    isValidItem: function (id, data, count) {
        return id === 1;
    }
});

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

let gui = new UI.StandartWindow({
    standart: {
        header: {
            text: {
                text: "Custom Gui"
            }
        },
        inventory: {
            standart: true
        },
        background: {
            standart: true
        }
    },
    drawing: [],
    elements: {}
});

IDRegistry.genItemID("backpackTest");
Item.createItem("backpackTest", "Test Backpack", {name: "backpackMiners", meta: 0}, {stack: 1});

BackpackRegistry.register(ItemID.backpackTest, {
    gui: gui
});