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

Версия 21:46, 24 апреля 2020

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

Содержание

1 Загрузка
2 Условия использования
3 Документация
- 3.1 Остальные методы BackpackRegistry

Загрузка

Версия	Ссылка	Список изменений	Дата релиза
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
});

Остальные методы BackpackRegistry

Название	Аргументы	Описание
openGuiFor	item, notUpdateData	Открывает интерфейс рюкзака. Если notUpdateData равен false и для переданной даты не заригестрирован контейнер, в руку игрока будет установлен новый предмет. Возвращает дату, которая может отличаться от переданной
isBackpack	id	Возвращает истину, если предмет с переданным айди - рюкзак
addSlotsToGui	gui, slots, isValidFunc, inRow, center, x, y	Технический метод добавляет слотов в объект интерфейса

@@ Строка 55: / Строка 55: @@
 Используя данный продукт&nbsp;вы автоматически соглашаетесь с этими правилами
 <div class="mw-parser-output"><div class="mw-parser-output"><div class="mw-parser-output">
+<div class="mw-parser-output">
 == Документация ==
@@ Строка 82: / Строка 83: @@
 *''<u>inRow&nbsp;</u>''- количество слотов в ряду
 *''<u>slotsCenter&nbsp;</u>''- центрировать ли слоты по ширине
-*''<u>useExtraData</u>&nbsp;''- использовать ExtraData для сохранения id контейнера рюкзака.
+*''<u>kind</u>'' - определяет способ хранения уникального айди рюкзака. Может иметь значения BackpackKind.EXTRA и BackpackKind.META. Если установить первое значение, айди будет находиться в поле "__backpack_id" экстры, второе - в метаданных предмета
 *<u>''items''</u>- массив предметов, которые&nbsp;можно положить в рюкзак. Описывается&nbsp;регулярными&nbsp;выражениями, айди или&nbsp;объектом с айди и датой (причем оба свойства могут быть заданы&nbsp;регуляркой)
@@ Строка 130: / Строка 131: @@
 | style="text-align: center;" | '''openGuiFor'''
 | style="text-align: center;" | item, notUpdateData
-| Открывает интерфейс рюкзака. Если ''notUpdateData ''равен false и для переданной даты не зарегистрирован контейнер, в руку игрока установится новый предмет в дате или extra дате которого будет записан id нового контейнера. Возвращает id контейнера рюкзака.
+| Открывает интерфейс рюкзака. Если&nbsp;''notUpdateData&nbsp;''равен false и для переданной даты не заригестрирован контейнер, в руку игрока будет установлен новый предмет. Возвращает дату, которая может отличаться от переданной
 |-
 | style="text-align: center;" | '''isBackpack'''
@@ Строка 140: / Строка 141: @@
 | Технический метод добавляет слотов в объект интерфейса
 |}
-</div> </div> </div> </div> </div> </div> </div> </div>
+</div> </div> </div> </div> </div> </div> </div> </div></div>