Referencia de la API
Resumen de la API
El punto de entrada SofyCoreApi, el EventBus síncrono y el registro de placeholders, de los que parte cualquier integración.
net.sofycore.api
SofyCoreApi
Punto de entrada. Se registra en el ServicesManager de Bukkit durante onEnable; los servicios de datos aparecen cuando el almacenamiento está listo.
Acceso: Bukkit.getServicesManager().load(SofyCoreApi.class)
package net.sofycore.api;
public interface SofyCoreApi {
<T> Optional<T> service(Class<T> type);
EventBus events();
PlaceholderRegistry placeholders();
}<T> Optional<T> service(Class<T> type)Devuelve un servicio registrado, o vacío si su módulo está apagado o no está listo.
EventBus events()El bus de eventos del core (síncrono, independiente de la plataforma).
PlaceholderRegistry placeholders()El registro interno de placeholders.
net.sofycore.api
EventBus
Bus de eventos síncrono. Los eventos se ejecutan en el hilo que publica; las excepciones de los listeners llegan a quien publica.
package net.sofycore.api;
public interface EventBus {
<T> AutoCloseable subscribe(Class<T> type, Consumer<? super T> listener);
void publish(Object event);
default void publishIsolated(Object event, Consumer<Throwable> failure);
}<T> AutoCloseable subscribe(Class<T> type, Consumer<? super T> listener)Suscribe un listener. Cierra el handle devuelto para darlo de baja.
void publish(Object event)Publica un evento a sus suscriptores.
default void publishIsolated(Object event, Consumer<Throwable> failure)Publica e informa del fallo de un listener al callback en lugar de lanzarlo.
net.sofycore.api
PlaceholderRegistry
Registro interno de placeholders, usado también por el scoreboard y los menús.
package net.sofycore.api;
public interface PlaceholderRegistry {
void register(String identifier, Function<UUID, String> resolver);
String resolve(String identifier, UUID playerId);
}void register(String identifier, Function<UUID, String> resolver)Registra un resolutor para un identificador.
String resolve(String identifier, UUID playerId)Resuelve un identificador para un jugador.
net.sofycore.api.module
CoreModule
Contrato de ciclo de vida de un módulo.
package net.sofycore.api.module;
public interface CoreModule {
String id();
void start() throws Exception;
void stop() throws Exception;
}String id()Identificador del módulo.
void start() throws ExceptionInicia el módulo.
void stop() throws ExceptionDetiene el módulo y libera sus recursos.
Semántica del bus de eventos
- Los eventos son síncronos e independientes de la plataforma. Se ejecutan en el hilo que publica.
- Una excepción de un listener llega a quien publica. sofyCore publica la mayoría de eventos con
publishIsolated, así un listener que falla no detiene a los demás. - Las llamadas a Bukkit desde un listener deben programarse en el hilo del servidor cuando el evento no se publicó allí.
- Cierra el
AutoCloseableque devuelvesubscribeen tuonDisable.