Отправка сообщений
MessageDispatcher и EventMetadata, отправка сообщений через конвейер FlectonePulse с фильтрами, дистанцией, звуком и назначением
Отправить сообщение можно двумя способами
| Способ | Когда подходит |
|---|---|
MessageSender | Нужно просто отдать готовый Component одному игроку или в консоль |
MessageDispatcher | Нужен весь конвейер с локализацией, форматированием, фильтрами, дистанцией, звуком, прокси и интеграциями |
MessageSender
Пакетnet.flectone.pulse.platform.sender
import net.flectone.pulse.platform.sender.MessageSender;
import net.kyori.adventure.text.Component;
MessageSender messageSender = flectonePulse.get(MessageSender.class);
messageSender.sendMessage(fPlayer, Component.text("Привет"), false);
messageSender.sendToConsole(Component.text("Сообщение в консоль"));
messageSender.sendToConsole("Строку тоже можно");| Метод | Что делает |
|---|---|
sendMessage(FPlayer, Component, boolean silent) | Отправляет сообщение игроку или консоли |
sendToConsole(Component) | Отправляет компонент в консоль |
sendToConsole(String) | Отправляет строку в консоль |
Параметр silent отправляет пакет тихо, без сопутствующих эффектов клиента
MessageDispatcher
Пакетnet.flectone.pulse.dispatcher
Собирает сообщение, считает получателей, форматирует текст лично для каждого и отправляет
import net.flectone.pulse.dispatcher.MessageDispatcher;
MessageDispatcher messageDispatcher = flectonePulse.get(MessageDispatcher.class);| Метод | Что делает |
|---|---|
dispatch(EventMetadata, Set<FPlayer>) | Асинхронно рассылает событие сообщения указанному набору получателей. |
dispatch(MessageSendEvent) | Напрямую рассылает уже собранное событие сообщения. |
dispatch(EventMetadata) | Рассылает событие сообщения подходящим получателям, вычисляя их через createReceivers(EventMetadata). |
dispatch(ModuleLocalization, EventMetadata) | Рассылает событие сообщения от имени модуля и берёт локализацию из него. |
dispatch(ModuleName, EventMetadata) | Рассылает событие сообщения по имени модуля. |
dispatch(ModuleName, EventMetadata, Set<FPlayer>) | Рассылает событие сообщения заранее посчитанному набору получателей. |
createReceivers(EventMetadata) | Создаёт набор получателей для события сообщения на основе фильтров игроков, радиуса и настроек модуля. |
createReceivers(ModuleName, EventMetadata) | Создаёт набор получателей для события сообщения по имени модуля. |
createMessageEvent(FPlayer, EventMetadata) | Создаёт событие сообщения для конкретного получателя. |
createMessageEvent(FPlayer, ModuleName, EventMetadata) | Создаёт событие сообщения для конкретного получателя по имени модуля. |
Все методы возвращают набор игроков или событие с игроками, до которых сообщение дошло
EventMetadata
Описывает, как доставить сообщение. Кому, куда на экране, на какое расстояние, с каким звуком и надо ли дублировать его в Discord или на другие серверы. Ещё у него есть общий uuid, который объединяет все копии одного сообщения
import net.flectone.pulse.constant.ModuleName;
import net.flectone.pulse.model.event.EventMetadata;
import net.flectone.pulse.model.event.message.context.MessageContext;
import net.flectone.pulse.model.value.Destination;
import net.flectone.pulse.model.value.Range;
messageDispatcher.dispatch(EventMetadata.builder()
.range(Range.Type.SERVER)
.destination(Destination.EMPTY_CHAT)
.filter(receiver -> receiver.isOnline())
.messageContext(receiver -> MessageContext.builder()
.module(ModuleName.ADDON)
.sender(fPlayer)
.receiver(receiver)
.message("<display_name> <white>hello everyone")
.build()
)
.build()
);Без вызова messageContext(...) метод build() бросит NullPointerException. Это единственное обязательное поле
Методы билдера
| Метод | Что задаёт |
|---|---|
messageContext(Function<FPlayer, MessageContext>) | Строит контекст сообщения для каждого получателя, обязателен |
uuid(UUID) | Идентификатор, общий для всех копий сообщения. По умолчанию случайный |
filter(FPlayer) | Отправку только одному игроку |
filter(Collection<FPlayer>) | Отправку перечисленным игрокам |
filter(Predicate<FPlayer>) | Произвольное условие |
destination(Destination) | Место на экране |
range(Range) | Дистанцию распространения |
sound(Pair<Sound, PermissionSetting>) | Звук и право на его прослушивание |
proxy() | Отправку на другие серверы |
proxy(ProxyDataConsumer<DataOutputStream>) | Отправку на другие серверы вместе с данными |
integration() | Дублирование в Discord, Telegram и Twitch |
Каждый вызов filter() сужает аудиторию, условия складываются через and и не заменяют друг друга
Контекст для каждого получателя
Параметр метода messageContext это функция от получателя. Она вызывается отдельно для каждого игрока, поэтому текст можно подобрать под язык и настройки конкретного человека
.messageContext(receiver -> MessageContext.builder()
.module(ModuleName.ADDON) // какой модуль отправляет сообщение, указывать необязательно
.sender(fPlayer)
.receiver(receiver)
.message(localization(receiver).format()) // свой перевод каждому
.build()
)Destination
Пакетnet.flectone.pulse.model.value
Определяет, куда именно клиенту придёт сообщение
Destination.Type | Где рисуется |
|---|---|
CHAT | Обычный чат |
ACTION_BAR | Строка над хотбаром |
BOSS_BAR | Полоса босса |
TITLE | Заголовок по центру экрана |
SUBTITLE | Подзаголовок по центру экрана |
TAB_HEADER | Верх списка игроков |
TAB_FOOTER | Низ списка игроков |
TOAST | Всплывающее уведомление о достижении |
HEAD_TEXT | Текст над головой отправителя |
BRAND | Название сервера в отладочном экране |
Для назначений со значениями по умолчанию есть готовые константы, например Destination.EMPTY_CHAT, Destination.EMPTY_TITLE и Destination.EMPTY_TOAST. Если нужны свои параметры, у Destination есть поля subtext, bossBar, times, toast и headText, заполняются только те, что относятся к выбранному типу. Настройки HEAD_TEXT хранятся в HeadText, а значения по умолчанию лежат в Destination.DEFAULT_HEAD_TEXT
Range
Определяет, кто вообще увидит сообщение
Range.Type | Кто увидит |
|---|---|
PERMISSION | Игроки, которые имеют указанное право |
PLAYER | Только сам отправитель |
BLOCKS | Игроки в радиусе N блоков |
WORLD_NAME | Игроки в том же мире |
WORLD_TYPE | Игроки в мире того же типа |
SERVER | Все игроки этого сервера |
PROXY | Все игроки сети прокси |
// именованная область
Range serverRange = Range.get(Range.Type.SERVER);
// радиус в блоках
Range blocksRange = Range.get(100);Звук
Звук идёт парой вместе с правом, и игрок услышит его, только если это право у него есть
import net.flectone.pulse.model.value.Pair;
import net.flectone.pulse.model.value.Sound;
// у модулей звук берётся из конфигурации
.sound(module.soundOrThrow())Отдельно звук проигрывает SoundPlayer
import net.flectone.pulse.platform.sender.SoundPlayer;
SoundPlayer soundPlayer = flectonePulse.get(SoundPlayer.class);
soundPlayer.play(soundPermission, sender, receiver);Запись Sound хранит поля enable, volume, pitch, category и name
Прокси и интеграции
// продублировать сообщение на другие серверы сети
.proxy()
// то же самое, но с дополнительными данными
.proxy(output -> output.writeInt(percent))
// продублировать в Discord, Telegram и Twitch
.integration()Про передачу данных между серверами написано на странице прокси
Пример
Объявление всем игрокам сервера, заголовком и с уходом в сеть
import net.flectone.pulse.constant.ModuleName;
import net.flectone.pulse.model.entity.FPlayer;
import net.flectone.pulse.model.event.EventMetadata;
import net.flectone.pulse.model.event.message.context.MessageContext;
import net.flectone.pulse.model.value.Destination;
import net.flectone.pulse.model.value.Range;
import java.util.Set;
public void announce(FPlayer sender, String text) {
Set<FPlayer> received = messageDispatcher.dispatch(EventMetadata.builder()
.range(Range.Type.SERVER)
.destination(Destination.EMPTY_TITLE)
.filter(receiver -> !receiver.isConsole())
.messageContext(receiver -> MessageContext.builder()
.module(ModuleName.ANON)
.sender(sender)
.receiver(receiver)
.message("<gradient:#FF0000:#00FF00>" + text + "</gradient>")
.build()
)
.proxy()
.build()
);
getLogger().info("Сообщение получили " + received.size() + " игроков");
}Что происходит внутри
Метод createReceivers() считает получателей, применяет фильтры с дистанцией и смотрит, включён ли модуль для каждого игрока
Срабатывает MessagePrepareEvent, тут список получателей ещё можно поменять
Для каждого получателя собирается MessageContext и срабатывает MessageFormattingEvent
Текст проходит MessagePipeline и становится Component
Срабатывает MessageFormattedEvent, здесь можно заменить готовый компонент или отменить сообщение
Срабатывает MessageSendEvent, после чего сообщение уходит игроку
ModuleName это перечисление, свой элемент туда добавить нельзя. Для своих сообщений бери ModuleName.ADDON или существующий модуль или отправляй через MessageSender. Как настроить сам текст, написано на странице форматирования