Общая архитектура

FlectonePulse предоставляет механизм событий для взаимодействия между модулями и реагирования на действия игроков, сообщения и жизненный цикл проекта. Все события наследуются от базового класса Event и поддерживают механизм отмены (cancelled). Каждый Event является неизменяемым объектом, поэтому при внесении нового параметра создаётся новый объект, это нужно учитывать при обновлении ивента

Приоритеты обработки

EventDispatcher использует шесть уровней приоритета, определяющих порядок выполнения слушателей.

Также есть параметр ignoreCancelled и если он true, обработчик будет вызван, даже если событие уже отмечено (по умолчанию false)

Регистрация обработчиков событий

Для создания слушателя необходимо

import net.flectone.pulse.listener.PulseListener;
import net.flectone.pulse.model.event.Event;
import net.flectone.pulse.model.event.Pulse;

public class MyCustomListener implements PulseListener {

    // Если ивент изменяется, его обязательно нужно вернуть через return
    @Pulse(priority = Event.Priority.NORMAL)
    public Event onMessagePrepare(MessagePrepareEvent event) {
        MessageContext messageContext = event.context();

        // Изменяем содержимое сообщения во время форматирования
        String modifiedMessage = messageContext.getMessage() + " [Modified]";
        return event.withContext(messageContext.withMessage(modifiedMessage));
    }

    // ignoreCancelled = true означает, что метод будет вызван, даже если событие отменено
    @Pulse(priority = Event.Priority.LOWEST, ignoreCancelled = true)
    public void onPlayerJoin(PlayerJoinEvent event) {
        // Получаем айпи игрока при входе
        String playerIp = event.player().ip();
    }

}

Регистрация слушателя:

// Где-то в модуле или сервисе
private ListenerRegistry listenerRegistry;

public void init() {
    listenerRegistry.register(new MyCustomListener());
}

Типы событий

Базовый класс

Все события наследуются от базового класса Event, который поддерживает отмену. События могут быть отмечены с помощью .withCancelled(true);

События сообщений

Эти события управляют конвейером обработки сообщений: от форматирования до доставки.

События жизненного цикла игрока

События жизненного цикла плагина

События модулей

Примечания

• События обрабатываются синхронно в порядке приоритета. Не выполняйте долгих операций в обработчиках без крайней необходимости
• Используйте ignoreCancelled = true в аннотации @Pulse, если ваш обработчик должен выполниться даже после отмены события другими слушателями
• Для кастомных событий ваши классы должны наследовать Event и корректно реализовать механизм отмены.