ResourcePackManager API
ResourcePackManager stellt eine Java-API bereit, die es anderen Plugins ermöglicht, ihre Resource Packs zur Laufzeit für die Zusammenführung zu registrieren.
Zugriff auf die API
Die API-Klasse ist com.magmaguy.resourcepackmanager.api.ResourcePackManagerAPI. Alle Methoden sind statisch.
Ein Resource Pack registrieren
Es gibt drei Registrierungsmethoden, je nachdem ob dein Pack lokal, remote oder beides ist.
registerResourcePack
ResourcePackManagerAPI.registerResourcePack(
String pluginName,
String localPath,
String url,
boolean encrypts,
boolean distributes,
boolean zips,
String reloadCommand
);
Registriert ein Resource Pack, das von einem lokalen Pfad oder einer Remote-URL stammen kann. Genau einer von localPath oder url sollte nicht-null sein.
registerLocalResourcePack
ResourcePackManagerAPI.registerLocalResourcePack(
String pluginName,
String localPath,
boolean encrypts,
boolean distributes,
boolean zips,
String reloadCommand
);
Registriert ein Resource Pack von einem lokalen Pfad relativ zum plugins-Verzeichnis.
registerRemoteResourcePack
ResourcePackManagerAPI.registerRemoteResourcePack(
String pluginName,
String url,
boolean encrypts,
boolean distributes,
boolean zips,
String reloadCommand
);
Registriert ein Resource Pack, das von der angegebenen URL heruntergeladen wird.
Parameter
| Parameter | Beschreibung |
|---|---|
pluginName | Der Name deines Plugins, genau wie er in der Plugin-Liste erscheint. Groß-/Kleinschreibung wird beachtet. |
localPath | Relativer Pfad vom plugins-Verzeichnis zu deiner Resource-Pack-Datei oder deinem Ordner. |
url | URL zum Herunterladen des Resource Packs. |
encrypts | Für zukünftige Verwendung reserviert. Aktuell ohne Funktion. |
distributes | Für zukünftige Verwendung reserviert. Aktuell ohne Funktion. |
zips | Ob das Resource Pack bereits gezippt ist. Falls false, zippt ResourcePackManager es vor dem Zusammenführen. |
reloadCommand | Der Reload-Befehl für dein Plugin. Für zukünftige Verwendung reserviert. |
Einen Reload auslösen
ResourcePackManagerAPI.reloadResourcePack();
Lädt ResourcePackManager neu, was alle registrierten Packs erneut zusammenführt und das Ergebnis erneut hostet, wenn Auto-Hosting aktiviert ist.
Hinweise
- Über die API registrierte Packs nehmen an der
priorityOrderauf die gleiche Weise teil wie eingebaute Integrationen. Füge deinen Plugin-Namen zurpriorityOrderinconfig.ymlhinzu, um zu steuern, wo es in der Zusammenführungsreihenfolge steht. - Wenn dein Plugin-Name nicht in der
priorityOrderaufgeführt ist, erhält dein Pack die niedrigste Priorität. - Die Registrierung sollte während des
onEnableoder der Initialisierung deines Plugins stattfinden, bevor ResourcePackManager seine eigene Initialisierung abschließt und die erste Zusammenführung auslöst.