Contenido generado con IA — puede contener errores.

ExyliaLib/Referencia

Índice de módulos

Todos los módulos, para qué sirve cada uno, y dónde está su punto de entrada.

Página 51 de 5412 min de lectura

Todos los módulos se alcanzan igual: una clase estática con el nombre del módulo, normalmente con un of(plugin) que devuelve una vista que pertenece a tu plugin.

Módulos más nuevos#

Fundamentos#

MóduloPunto de entradaPara qué sirve
TaskTasks.of(plugin)Programación que corre en Spigot, Paper y Folia desde una llamada.
ConfigConfigs.define(plugin, nombre, tipo)Archivos YAML declarados y leídos como records de Java.
TextText.of(cadena)Cada cadena visible, a componentes de Adventure.
PlaceholdersPlaceholders.group(plugin, prefijo)Un registro para %placeholders%, con o sin PlaceholderAPI.
FormatsFormats, AmountsNúmeros, dinero, porcentajes y fechas que lee un jugador — y cantidades que teclea.
DebugDebug.of(plugin)Salida de consola con color, con un interruptor global.
ReloadingReloads.of(plugin)Pasos de recarga con nombre y fallos contenidos, más listeners de recarga de la librería.
ModulesPluginModules.of(plugin, interruptores)Partes de un plugin que se encienden y apagan, cada una con sus archivos, listeners, acciones, menús, comandos y temporizadores.
MetricsMetrics.describe(plugin, detalles)Cómo se describe la configuración de un plugin a stats.exylia.net. Ver Métricas.
Web editorWebEditor.of(plugin)Editar los archivos de un plugin desde el navegador.
LogsLogs.of(plugin)Un registro de auditoría del staff en el que escribe cada plugin, leído con /exylialib logs.

Almacenamiento#

MóduloPunto de entradaPara qué sirve
DatabaseDatabases.of(plugin)Records en H2, MySQL, MariaDB, PostgreSQL o MongoDB.
TransferTransfers.of(plugin)La base de datos entera de un plugin a un archivo y de vuelta.
RedisconfiguraciónUna caché compartida que hace que una base de datos se vea igual desde cada servidor.
SnapshotsSnapshots.of(plugin)El estado de un jugador guardado para después, en memoria o almacenado.
ProxyProxy.request(módulo, payload)Hablar con ExyliaProxyUtils en Velocity o BungeeCord, con respuesta a cada petición.

Interfaces#

MóduloPunto de entradaPara qué sirve
MenusMenus.of(plugin)Menús escritos en configuración: listas, plantillas, condiciones, valores en vivo.
ItemsItems.of(plugin)Items descritos en configuración, leídos una vez y dibujados por jugador.
ActionsActions.of(plugin, namespace)Acciones compiladas y con namespace, compartidas por menús e items.
InputInputs.of(plugin)Pedirle a un jugador texto, números, opciones o un formulario entero.
EditorsEditors.of(plugin)Pantallas para editar las listas que configura un plugin.
WizardsWizards.of(plugin)Guiar a un jugador por varias preguntas, aplicadas solo al confirmar.
PreviewsPreviews.of(plugin)Mostrarle a un jugador un efecto contra un cielo vacío.
HeadsHeads.browse(inputs, …)El catálogo de cabezas decorativas, buscable desde un menú, una página cada vez.
InteractionsInteractions.compile(plugin, lineas)Lo que hace hacer clic en algo del mundo: líneas con filtros de clic, comandos y tokens de efecto.
TunerTuner.of(plugin, sujeto)Ajuste fino con la rueda del ratón, con un HUD en boss bar y vista previa en vivo.
SettingsSettings.register(plugin, ajuste)Preferencias de jugador que registra cada plugin, y la única pantalla /settings.
ToastsToasts.send(player, icono, título, marco)El aviso de logro de la esquina, con una alternativa configurable.
NoticesNotices.of(plugin)Mensajes dejados a un jugador: mostrados ahora, a través de la red, o en su próxima entrada.
Discord webhooksWebhooks.of(plugin)Mensajes a Discord escritos en config, con valores escapados y límites de ritmo.

En pantalla#

MóduloPunto de entradaPara qué sirve
EffectsEffects.play(config, viewer)Títulos, barras de acción, boss bars, sonidos, partículas, fuegos.
SequencesSequences.of(plugin)Efectos coreografiados desde configuración: veintiséis formas, sonidos, pausas, displays y cuerpos.
DisplaysDisplays.of(plugin)Displays de objeto, bloque y texto que se mueven, giran y caen solos, animados por el cliente.
NPCsNpcs.of(plugin)Cuerpos con forma de jugador que solo existen en un cliente.
RagdollsRagdolls.of(plugin)Uno de esos cuerpos deshaciéndose, en doce poses.
OverlaysOverlays.of(plugin)Objetos en el inventario del jugador que el servidor no tiene.
PacketsPackets.of(plugin)Vanish, bloques falsos, bordes del mundo por jugador, congelar, un espectador falso, mirar cofres en silencio y líneas en items.
ScoreboardScoreboards.show(plugin, player, config)Sidebars por paquetes declarados en config.
HologramHolograms.show(plugin, id, location, config)Hologramas por paquetes declarados en config: etiquetas por línea, páginas, clics y botones.
NametagsNametags.of(plugin)Color del nombre, brillo y colisión según quién mira.
ChatChats.rule(plugin, rule)Quién lee los mensajes de quién, quitados de la audiencia antes de entregar.
CosmeticsCosmetics.rule(plugin, rule)Si se dibujan los cosméticos de un jugador — la pregunta que hace cada plugin cosmético.
ClientClients.of(plugin)Lunar, Feather y el mod de SurvivalCore: waypoints, equipos, temporizadores y barras en el HUD, cooldowns.
SkullsSkulls.player(nombre)Cabezas de jugador desde base64, una URL o un nombre — cacheadas y sin bloquear.
ModelsModels.of(plugin)Modelos de Blockbench que llevan entidades vivas, sin resource pack.
VFXVfx.at(ubicación)Efectos construidos en Java y reproducidos como una línea de tiempo: displays, sonidos, partículas, temblor de pantalla.
CamerasCameras.of(plugin)Mostrarle a un jugador a sí mismo desde fuera, devolviéndole siempre la vista.
ReplaysReplays.of(plugin)Grabar lo que pasó y reproducirlo como cuerpos por paquetes.
ShowcasesShowcases.of(plugin)Lugares que muestran en bucle los cosméticos de un plugin a quien se acerque.

Mundo#

MóduloPunto de entradaPara qué sirve
RegionsRegions.of(plugin)Formas, un índice espacial, políticas de solape, eventos de entrada y salida, contornos.
SchematicsSchematics.of(plugin)Guardar una caja del mundo y pegarla de vuelta.
WorldWorlds.create(key, nombre)Crear y borrar mundos, desde cualquier hilo.
WorldGuardWorldGuardRegions, WorldGuardFlagsConsultas de región y las flags propias del ecosistema — kill-effects, hit-effects, arrows-effects — sin dependencia en compilación.
BlocksBlocks.of(plugin)Bloques que responden a clics en vez de comportarse como su material, y si un bloque lo puso un jugador.

Jugadores#

MóduloPunto de entradaPara qué sirve
SessionsSessions.of(plugin)Un registro de reservas para que dos plugins no tengan al mismo jugador.
PlayersExyliaPlayers.of(…)Un ExyliaPlayer sobre jugadores conectados, desconectados y de la red, resuelto sin bloquear.
StaysStays.of(plugin)Un jugador retenido en una arena y devuelto exactamente como llegó.
CooldownsCooldowns.forPlugin(plugin)La base sobre la que se apoya cada cooldown del ecosistema.
SchedulesSchedules.of(plugin)Horarios: qué arranca solo, cuándo y bajo qué condiciones.
TeleportTeleports.of(plugin)Calentamientos, aterrizajes seguros, /back, peticiones y traspasos.
CombatCombat.isTagged(player)Si un jugador está peleando, sobre DeluxeCombat o PvPManager.
ClanClans.clanOf(uuid)Una API sobre ocho plugins de clanes y puentes externos.
MobsMobs.of(plugin)Mobs personalizados desde una plantilla, con habilidades, fases y quién los hirió informado al morir.

Lo que gana un jugador#

MóduloPunto de entradaPara qué sirve
RewardsRewards.of(plugin)Items, comandos, dinero, probabilidades y condiciones — a prueba de desconexiones.
LootLoot.parseAll(lineas)Lo que sale de un cofre, un generador o un bloque roto.
EconomyEconomy.balance(uuid)Saldos, cobros y transferencias sobre Vault, PlayerPoints o tu propia moneda.
CratesCrates.of(plugin)La tirada, las llaves, los rodillos, el pago y los bloques de una caja, compartidos; las recompensas quedan para el plugin.
ModifiersModifiers.register(plugin, proveedor)Una sola cadena de multiplicadores para lo que ganan los jugadores, alimentada por boosters, rangos y lugares.
PricesPrices.sell(stack)Por cuánto se vende un item, respondido por la tienda o lista de precios que lo tenga.

No son módulos#

ClaseQué es
net.exylia.lib.ExyliaLibEl plugin en sí: ciclo de vida y limpieza, nada más.
net.exylia.lib.platform.Platformcurrent(), isFolia(), isPaper().
net.exylia.lib.api.practicebot.PracticeBotsEn el artefacto de la API pública: un puente al plugin de bots de entrenamiento, get() y available(). Vacío cuando no está.
net.exylia.lib.internal.*Interno. Libre de cambiar sin aviso.
CleanupSin API: plugins/ExyliaLib/cleanup.yml. Barre la carpeta logs/ del servidor de archivos con más de keep-days días, un minuto tras arrancar y cada seis horas.

Recargar#

java
Reloads.of(this)
        .step("configs", () -> { settings.reload(); menus.reload(); })
        .step("arenas", () -> arenas.load())
        .run(sender);

Cada paso informa por sí mismo: uno que lance se nombra en consola y al emisor se le dice cuántos salieron bien. Un plugin recargado a medias que no dice nada es peor que uno que nombra lo que falló.

Cuando /exylialib reload ve que cambió el idioma de un plugin (language: default siguiendo un idioma nuevo de la librería), ejecuta una vez todo su Reloads declarado, así menús, mensajes y catálogos leen el idioma nuevo sin un segundo comando (1.534.0+). Los plugins van por turnos, uno cada pocos ticks, para que el servidor siga corriendo mientras se extiende el idioma (1.542.0+).

El Reloads que un plugin declaró por última vez es también lo que se ejecuta después de que /exylialib updates apply o el editor web escriben uno de sus archivos, así que el cambio queda activo sin recargar a mano. Decláralo una vez, en un campo, en vez de construirlo dentro del comando de recarga.

java
Reloads.onLibraryReload(this, () -> menus.reload());

El /exylialib reload de la propia librería dispara ese listener. El motivo habitual de quererlo es que cambie la paleta: cada menú compilado se queda con los colores de la semana pasada hasta que se vuelve a leer.

Módulos de plugin#

Un plugin hecho de partes que el dueño del servidor enciende y apaga. Cada parte tiene sus archivos, listeners, acciones, menús, comandos y temporizadores, y una parte apagada no cuesta nada.

java
modules = PluginModules.of(this, id -> settings.get().modules().switchOf(id));
modules.register(new MarketModule());
modules.register(new AuctionsModule());          // requiredModules() devuelve ["market"]
modules.registerActions(actions);                // antes de compilar los menús
menus.load(modules.menuIds());
modules.commandHandlers().forEach(lamp::register);
modules.loadOnlinePlayers(Bukkit.getOnlinePlayers());
modules.startTimers();
java
public final class AuctionsModule extends PluginModule {
    public AuctionsModule() { super("auctions"); }
 
    @Override protected List<String> requiredModules() { return List.of("market"); }
    @Override protected void registerConfigs() { config("modules/auctions/config", AuctionsConfig.class).load(); }
    @Override protected void onEnable() { manager = new AuctionManager(); }
    @Override protected void onDisable() { if (manager != null) manager.shutdown(); }
    @Override protected List<Object> commandHandlers() { return List.of(new AuctionsCommand()); }
    @Override protected void timers() { timer(20L, 20L, () -> manager.sweep()); }
}
El interruptor se lee al arrancarUn módulo cuyo id no tiene interruptor en la config se queda apagado y se informa, para que una clave mal escrita nunca falle en silencio. Un interruptor cambiado después solo lo informa pendingRestart().
RequisitosrequiredPlugins() y requiredModules() mantienen un módulo apagado, con una línea en consola, mientras falte lo que necesita.
Un módulo nunca tumba a los demásUn módulo que lanza al activarse pierde los listeners nuevos, recibe su propio onDisable y se queda apagado; el resto arranca igual.
Las consultas solo responden por módulos en marchagetModule(id) e isEnabled(id) están vacíos para un módulo apagado, sin requisitos o que falló.
RecargareloadConfigs() recarga cada módulo en marcha, cada uno por su cuenta. reload(id) recarga un solo módulo en el sitio — para un editor en el juego que cambió los ajustes de un módulo.
ComandoscommandHandlers() devuelve objetos handler simples para que el plugin los registre con su propio Lamp. registerCommands(lamp) está obsoleto.

Al desactivar, disableAll() desactiva los módulos en marcha en orden inverso.

Cambiar un módulo en caliente#

Desde 1.557.0, modules.setEnabled("auctions", false) enciende o apaga un módulo sin reiniciar y devuelve un ModuleToggle (succeeded(), changed(), missing(), menus()). Guardar el interruptor es cosa del plugin.

EstadoSignificado
ENABLED / DISABLEDahora corre, o está apagado; changed() guarda los dependientes que se movieron con él
UNCHANGEDya estaba en ese estado
BLOCKEDsigue apagado: missing() nombra los plugins o módulos que necesita y no corren
FAILEDlanzó al activarse, se liberó y sigue apagado
UNKNOWNningún módulo tiene ese id
  • Apagar: todo módulo en marcha que lo necesita se apaga antes, el último registrado primero: se quitan los listeners de onEnable, paran los temporizadores y corre onDisable. Encender: registerConfigs, onEnable, acciones, jugadores conectados, temporizadores, y luego vuelven los dependientes cuyo interruptor está activo. El interruptor pedido gana el resto de la ejecución.
  • Las acciones de un módulo apagado responden stop("switched off") (actions.onlyWhile(module::isEnabled)), así los menús compilados siguen valiendo.
  • Los comandos no se pueden desregistrar en Lamp: registra modules.allCommandHandlers() y rechaza los comandos de un módulo apagado con una commandCondition que use modules.offModuleOf(method).

Salida de depuración#

java
Debug debug = Debug.of(this);
 
debug.success("Configs cargadas");
debug.warn("La arena 'main' no tiene esquemática");
debug.error("No se pudo alcanzar la base de datos", failure);
debug.debug("Sesión vaciada: " + entries);      // solo con debug activo

Debug.all(true) enciende las líneas de debug de todos los plugins a la vez, que es el interruptor al que acudir para reproducir algo en vez de editar la config de cada plugin.

¿Falta algo en esta página? Dínoslo en Discord