Перейти к основному содержимому

API ResourcePackManager

ResourcePackManager предоставляет Java API, позволяющий другим плагинам регистрировать свои ресурс-паки для объединения во время выполнения.

Доступ к API

Класс API — com.magmaguy.resourcepackmanager.api.ResourcePackManagerAPI. Все методы статические.

Регистрация ресурс-пака

Существует три метода регистрации в зависимости от того, является ли ваш пак локальным, удалённым или и тем и другим.

registerResourcePack

ResourcePackManagerAPI.registerResourcePack(
String pluginName,
String localPath,
String url,
boolean encrypts,
boolean distributes,
boolean zips,
String reloadCommand
);

Регистрирует ресурс-пак, который может быть получен из локального пути или удалённого URL. Ровно один из параметров localPath или url должен быть не null.

registerLocalResourcePack

ResourcePackManagerAPI.registerLocalResourcePack(
String pluginName,
String localPath,
boolean encrypts,
boolean distributes,
boolean zips,
String reloadCommand
);

Регистрирует ресурс-пак из локального пути относительно директории plugins.

registerRemoteResourcePack

ResourcePackManagerAPI.registerRemoteResourcePack(
String pluginName,
String url,
boolean encrypts,
boolean distributes,
boolean zips,
String reloadCommand
);

Регистрирует ресурс-пак, который будет загружен по указанному URL.

Параметры

ПараметрОписание
pluginNameИмя вашего плагина точно так, как оно отображается в списке плагинов. Чувствительно к регистру.
localPathОтносительный путь от директории plugins к файлу или папке вашего ресурс-пака.
urlURL для скачивания ресурс-пака.
encryptsЗарезервировано для будущего использования. В настоящее время не функционирует.
distributesЗарезервировано для будущего использования. В настоящее время не функционирует.
zipsЗаархивирован ли ресурс-пак. Если false, ResourcePackManager заархивирует его перед объединением.
reloadCommandКоманда перезагрузки вашего плагина. Зарезервировано для будущего использования.

Принудительная перезагрузка

ResourcePackManagerAPI.reloadResourcePack();

Перезагружает ResourcePackManager, который повторно объединяет все зарегистрированные паки и повторно хостит результат, если включён автохостинг.

Примечания

  • Паки, зарегистрированные через API, участвуют в priorityOrder так же, как встроенные интеграции. Добавьте имя вашего плагина в priorityOrder в config.yml, чтобы контролировать его позицию в порядке объединения.
  • Если имя вашего плагина не указано в priorityOrder, ваш пак получает самый низкий приоритет.
  • Регистрация должна происходить в onEnable вашего плагина или при инициализации, до того как ResourcePackManager завершит свою собственную инициализацию и запустит первое объединение.