Saltar al contenido principal

API de ResourcePackManager

ResourcePackManager expone una API de Java que permite a otros plugins registrar sus paquetes de recursos para su fusión en tiempo de ejecución.

Acceso a la API

La clase de la API es com.magmaguy.resourcepackmanager.api.ResourcePackManagerAPI. Todos los métodos son estáticos.

Registrar un Paquete de Recursos

Existen tres métodos de registro dependiendo de si tu paquete es local, remoto, o cualquiera de los dos.

registerResourcePack

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

Registra un paquete de recursos que puede provenir de una ruta local o una URL remota. Exactamente uno de localPath o url debe ser no nulo.

registerLocalResourcePack

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

Registra un paquete de recursos desde una ruta local relativa al directorio plugins.

registerRemoteResourcePack

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

Registra un paquete de recursos que se descargará desde la URL proporcionada.

Parámetros

ParámetroDescripción
pluginNameEl nombre de tu plugin exactamente como aparece en la lista de plugins. Sensible a mayúsculas y minúsculas.
localPathRuta relativa desde el directorio plugins hacia tu archivo o carpeta de paquete de recursos.
urlURL para descargar el paquete de recursos.
encryptsReservado para uso futuro. Actualmente no hace nada.
distributesReservado para uso futuro. Actualmente no hace nada.
zipsSi el paquete de recursos ya está comprimido en zip. Si es false, ResourcePackManager lo comprimirá antes de fusionarlo.
reloadCommandEl comando de recarga de tu plugin. Reservado para uso futuro.

Activar una Recarga

ResourcePackManagerAPI.reloadResourcePack();

Recarga ResourcePackManager, lo que vuelve a fusionar todos los paquetes registrados y vuelve a alojar el resultado si el alojamiento automático está habilitado.

Notas

  • Los paquetes registrados a través de la API participan en priorityOrder de la misma manera que las integraciones incorporadas. Agrega el nombre de tu plugin a priorityOrder en config.yml para controlar dónde se ubica en el orden de fusión.
  • Si el nombre de tu plugin no está listado en priorityOrder, tu paquete recibe la prioridad más baja.
  • El registro debe realizarse durante el onEnable o la inicialización de tu plugin, antes de que ResourcePackManager termine su propia inicialización y active la primera fusión.