API
Leer el catálogo de trims, las mitades que el jugador combina a mano, el trim que eligió y el que se le ve, los trims escritos en la armadura, y los dos eventos.
ArmorTrimService es por donde otro plugin lee y maneja ExyliaArmorTrims: los patrones y materiales que
combina el jugador, el trim que eligió, y los trims escritos en la armadura misma.
ExyliaAPI.get(ArmorTrimService.class).ifPresent(trims -> {
trims.select(player, ArmorPiece.CHESTPLATE, "sentry/netherite");
trims.trimItem("rib/redstone").ifPresent(item -> player.getInventory().addItem(item));
});El artefacto, el repositorio y la línea del plugin.yml son los mismos para todos los plugins de
Exylia y están en la página de la API pública. shown, giveTrimItem,
removerItem, openMenu y los dos eventos llegaron con ExyliaArmorTrims 1.3.0, en exylia-api
v1.133.0: compila contra esa etiqueta o una más nueva para usarlos.
Todo se direcciona por id de trim, comparado sin distinguir mayúsculas: la forma patrón/material
de una combinación — sentry/netherite. Un id de preset de antes de la 1.5.0 se sigue leyendo como el
aspecto que representaba. Un id que no nombra nada de lo que ofrece el catálogo no es un error, así que
las búsquedas devuelven vacío y las escrituras devuelven false.
trims() devuelve ahora siempre una lista vacía y exists siempre false: listaban presets, y ya no
hay. Lee patterns() y materials() para el catálogo, y trim(String) para una combinación. Todo
ArmorTrim tiene preset en false, permission vacío y las cuatro piezas.
El catálogo#
| Método | Qué hace |
|---|---|
trims() | Siempre vacío desde la 1.5.0: listaba presets. Las combinaciones son demasiadas para listarlas. |
trim(String trimId) | Un trim como Optional<ArmorTrim>, aceptando una combinación patrón/material. Vacío cuando alguna de las dos mitades no se ofrece. |
exists(String trimId) | Siempre false desde la 1.5.0: preguntaba por presets. Usa trim en su lugar. |
patterns() | Los patrones que el jugador puede combinar a mano, en orden de menú. |
materials() | Los materiales que el jugador puede combinar a mano, en orden de menú. |
Permisos#
| Método | Qué hace |
|---|---|
canUse(Player, String trimId) | Si puede llevar el trim. |
canUse(Player, String trimId, ArmorPiece) | La misma respuesta: un trim encaja en todas las piezas. Se mantiene para quien llama escrito contra presets. |
Los dos responden con la regla del propio servidor: las dos mitades, cada una por su nodo o por lo que desbloqueó una caja o una compra. Una tienda que pregunta recibe la misma respuesta que daría el menú, no una comprobación cruda de nodo.
Lo que eligió el jugador#
| Método | Qué hace |
|---|---|
mode() | De dónde salen los trims que dibuja este servidor, como TrimMode. |
selected(UUID player, ArmorPiece) | El id de trim elegido para esa ranura, como Optional<String>. Vacío cuando no eligió ninguno, el menú está apagado, o su selección todavía se está leyendo. |
select(Player, ArmorPiece, String trimId) | Fija la elección de esa ranura. true cuando quedó guardada. |
clear(Player, ArmorPiece) | Quita el trim elegido de una ranura. true cuando había algo que quitar. |
clearAll(Player) | Quita todos los trims elegidos. true cuando había algo que quitar. |
selected es una elección, no un resultado: sigue puesta con la ranura vacía, y el trim vuelve a
aparecer en cuanto el jugador se equipa una armadura que encaje.
select fija en vez de alternar: llamarlo dos veces deja el trim puesto. No comprueba si el jugador
lo tiene: quien llama ya decidió que puede llevarlo. Es la misma regla que sigue ExyliaArrows y lo
contrario de ExyliaArmorSkin. Pregunta antes por canUse(Player, String, ArmorPiece) cuando sí quieras
que eso decida.
TrimSelectionChangeEvent se lanza igual que con un clic del menú; un listener que lo cancela hace que
select responda false.
Lo que se le ve puesto#
| Método | Qué hace |
|---|---|
shown(UUID player, ArmorPiece) | El trim que se dibuja en esa ranura ahora mismo, como Optional<String>: una combinación patrón/material. |
La respuesta después de que cada regla haya dicho lo suyo — el modo, la armadura que de verdad hay en
la ranura, si el portador lo tiene y si sus cosméticos se muestran — que ni selected ni trimOf dan
por sí solos. Vacío cuando la ranura muestra la armadura tal cual o el jugador no está conectado. Es lo
que debe leer un placeholder o un scoreboard que describe el aspecto de alguien; seguro desde
cualquier hilo.
Trims en los objetos#
| Método | Qué hace |
|---|---|
trimOf(ItemStack armor) | El id de trim escrito en esa armadura, como Optional<String>. Vacío cuando no lleva ninguno. |
apply(ItemStack armor, String trimId) | Escribe un trim en la armadura, en el sitio, conservando todo lo demás que tenía. true cuando se escribió. |
strip(ItemStack armor) | Quita el trim y no devuelve nada a cambio. true cuando había uno. |
trimItem(String trimId) | Un objeto de trim listo para entregar, como Optional<ItemStack>. Vacío cuando el id no nombra ningún trim. |
isTrimItem(ItemStack) | Si un objeto es uno de los objetos de trim del plugin. |
Pregunta isTrimItem antes de que un cofre, una tienda o un intercambio traten un stack como botín
normal: un objeto de trim se dibuja como le convenga y no es el material que aparenta.
Entregar cosas#
| Método | Qué hace |
|---|---|
giveTrimItem(Player, String trimId, int amount) | Da objetos de trim por la cola de recompensas del plugin: lo que no cabe se guarda y se entrega cuando el jugador vuelve a entrar. Al jugador no se le dice nada. false cuando el id no nombra ningún trim o la cantidad es menor que uno. |
removerItem() | Un removedor nuevo, listo para entregar. Solo quita trims en un servidor cuyo modo usa objetos. |
openMenu(Player) | Abre el menú de trims como lo hace /trims — el clásico o el vestidor 3D, según menu-style y el nodo del vestidor — para un NPC, un cartel o un objeto del lobby. No comprueba el nodo del comando. false cuando el modo no tiene menú. |
Llama a giveTrimItem y openMenu en el hilo dueño del jugador.
Redibujar#
| Método | Qué hace |
|---|---|
refresh(Player) | Recalcula cómo se ve el jugador y lo reenvía a todos los que puedan verlo. |
Solo hace falta cuando cambió algo que el service no conoce: un permiso concedido en caliente, un objeto cambiado por otro plugin. Todas las escrituras de arriba ya redibujan.
Tipos#
ArmorTrim — id, name (con los códigos de color dentro), permission, pieces, pattern,
material y preset. Desde la 1.5.0 todo trim es una combinación: permission viene vacío, porque lo
conceden las dos mitades que hay detrás, pieces lleva las cuatro y preset es false.
TrimOption — una mitad de las que el jugador combina a mano: id, name, permission. Patrones
y materiales comparten el record, y cuál es cada uno lo dice el método que te lo entregó. Existen
porque un trim se vende por mitades.
ArmorPiece — HELMET, CHESTPLATE, LEGGINGS, BOOTS. slot() da el EquipmentSlot de
Bukkit, para que quien lea un inventario no mantenga un switch propio al día.
TrimMode — de dónde sale el trim dibujado: ITEM (solo lo que un objeto de trim escribió en la
armadura), MENU (solo lo que eligió quien la lleva; los objetos de trim no hacen nada) o BOTH.
usesItems() y usesMenu() responden sin switch. Vale la pena preguntarlo antes de escribir nada: la
mitad que un servidor no usa devuelve false o vacío en lugar de lanzar, así que una integración
escrita para las dos funciona en cualquiera.
Todo lo que devuelve un valor lee la caché del plugin y es seguro desde un redibujado de menú o un placeholder. Todo lo que cambia una selección escribe en la base de datos y redibuja al jugador para todos los que lo ven: llama a eso desde el hilo principal, y no más seguido de lo que podría un jugador.
Eventos#
Los dos están en net.exylia.lib.api.armortrims.event, se pueden cancelar y se llaman en el hilo dueño
del jugador, que en Folia es el hilo de su región.
TrimSelectionChangeEvent — los trims que eligió un jugador están a punto de cambiar. Un evento por
escritura, toque las ranuras que toque: pieces() son las ranuras y trimId() a lo que cambian todas,
vacío cuando se quitan. Se lanza por un clic en el menú, un comando de admin y el select y los clears
del servicio por igual, y solo cuando se sabe que la escritura cambia algo. Cancelarlo no escribe nada
ni explica nada.
TrimApplyEvent — un jugador suelta un objeto de trim sobre una armadura, después de que el plugin
lo haya aceptado y antes de escribir nada. armor() es el objeto vivo, trimId() el trim que se pone,
piece() la ranura. No se lanza con apply. Cancelarlo deja la armadura sin trim y el objeto en el
cursor.
@EventHandler
public void onTrim(TrimSelectionChangeEvent event) {
if (arena.isPlaying(event.getPlayer())) event.setCancelled(true);
}Lo que no expone#
Los flujos del menú y del vestidor, la caja y las filas crudas de configuración quedan fuera a propósito: un contrato público no se puede romper después, así que lleva lo que una integración necesita y nada que solo tuviera sentido dentro de una versión.
Si de verdad te falta algo, pídelo en Discord.
¿Falta algo en esta página? Dínoslo en Discord