Contenido generado con IA — puede contener errores.

ExyliaLib/Interfaces

Chat

Quién lee el chat de quién, y sacar una línea del chat antes de que nadie más la lea.

Página 27 de 545 min de lectura

Un plugin registra una regla y la librería quita de cada mensaje a los receptores que esa regla rechaza, antes de que el servidor lo entregue — un evento cuyos jugadores solo hablan entre ellos, una arena cuyo chat no sale de ella, un espectador que lee una partida sin que le lean a él.

java
Chats.rule(this, (listener, speaker) -> {
    var theirs = events.eventOf(listener);
    var his = events.eventOf(speaker);
    if (theirs.isEmpty() && his.isEmpty()) return true;   // los dos fuera
    if (theirs.isEmpty() || his.isEmpty()) return false;  // nunca cruza
    return theirs.get() == his.get();
});
MétodoQué hace
Chats.rule(plugin, rule)Registra la regla de este plugin, reemplazando la anterior.
Chats.clear(plugin)La quita.
Chats.canHear(listener, speaker)La respuesta en la que coinciden todas las reglas, para texto que un plugin entrega por su cuenta.
Chats.bypass(player, bypass)Pone a un jugador por encima de todas las reglas, o lo vuelve a poner debajo.
Chats.bypassing(uuid)Si está por encima de las reglas ahora mismo.

ChatRule es una interfaz funcional: boolean canHear(Player listener, Player speaker).

Cómo se comporta#

No se cancela ni se reenvía nadaEl mensaje conserva el formato, el hover y los clics que le dio su plugin de chat; solo la audiencia es menor. La consola conserva la línea completa.
Todas las reglas tienen que estar de acuerdoSe combinan con AND: un mensaje llega a un jugador solo si ningún plugin se opone. Una regla por plugin, que se cae al desactivarlo.
La pregunta es asimétricacanHear(a, b) y canHear(b, a) son respuestas distintas — que es lo que permite que un espectador lea una partida sin que le lean.
Quien habla siempre se leeA las reglas ni se les pregunta por eso.
Un bypass es la única forma de pasar un noNinguna regla puede deshacer el rechazo de otro plugin, así que Chats.bypass saca al jugador de la pregunta: lee todos los mensajes y todos lo leen a él. Es para que el staff lea un chat aislado. Dura hasta que se desconecta; guárdalo y vuelve a fijarlo al entrar si quieres recordarlo.
No se recuerda nada entre mensajesLa regla se pregunta al entregar el mensaje, así que quien entra a mitad de frase ya está dentro para la línea siguiente.
Una regla rota pierde su voto, no el chatUna regla que lanza excepción se ignora en ese mensaje y se avisa una vez, por nombre de plugin.
Sin reglas no cuesta nadaEl handler lee un mapa y vuelve.

Qué necesita, y qué no cubre#

Un plugin de chat que deje entregar el mensaje al servidor: el chat propio de Paper y cualquier plugin de chat basado en renderer lo hacen. Solo se maneja el moderno AsyncChatEvent. Cuando un plugin todavía escucha el antiguo AsyncPlayerChatEvent, Paper corre ése primero y pasa sus receptores al evento moderno, así que la audiencia recortada acá es la que se entrega en cualquier caso.

Un plugin que en vez de eso cancela el evento y manda cada línea por su cuenta se ha quedado con la entrega; esas copias quedan fuera de alcance, y una audiencia entregada como inmutable se avisa una vez y se deja en paz. Los dos casos fallan abiertos: el chat sigue funcionando y el aislamiento no se aplica.

Chat, y solo chat. Los mensajes de entrada y salida, los de muerte, los broadcasts y los privados no son eventos de chat y no se tocan — tampoco un mensaje que llega de otro servidor por Redis, que aquí nunca fue un evento de chat. Ése se filtra donde se entrega, con Chats.canHear.

Las reglas se preguntan en el hilo del chat

No en el principal. Una regla tiene que ser barata y leer solo estado compartido: sin tocar el mundo, sin tocar entidades, sin bloquear. Registrar y quitar una regla es seguro desde cualquier hilo.

Sacar una línea del chat#

ChatIntercept es la otra mitad del módulo, y otro trabajo: no quién lee un mensaje, sino un mensaje que nunca llega a serlo. Chat de staff, un canal de clan, una sesión de freeze, la respuesta a una pregunta — cada uno lee lo que escribió un jugador y lo cancela.

java
intercept = ChatIntercept.register(this, EventPriority.LOWEST, true, (player, message) -> {
    if (!staffChat.isToggled(player)) return false;
    staffChat.send(player, message);
    return true;   // sacado del chat público
});
 
intercept.close();   // cuando la función se apaga; desactivar el plugin también lo quita
LlamadaQué hace
ChatIntercept.register(plugin, priority, ignoreCancelled, intercept)Intercepta el chat en el evento que este servidor usa de verdad. El BiPredicate<Player, String> recibe el texto plano escrito y devuelve si se quedó con la línea: true la cancela.
close()Deja de interceptar.

Por qué no un listener de AsyncChatEvent y listo. En cuanto un plugin escucha el antiguo AsyncPlayerChatEvent — DiscordSRV, WorldGuard, un plugin de chat viejo — Paper pasa cada mensaje primero por el evento antiguo y recién después por AsyncChatEvent. Cancelar en el evento moderno llega después de que esos listeners ya leyeron la línea: DiscordSRV publica el canal de staff en Discord.

Así que la interceptación se registra donde está de verdad el chat. Si hay un listener antiguo, va en el evento antiguo, su cancelación es lo primero que ven los demás y Paper la lleva al evento moderno. Si no hay ninguno, se queda en AsyncChatEvent y el camino antiguo sigue apagado — registrar un listener antiguo es lo que lo enciende. La elección se hace un tick después de register, cuando todos los plugins ya registraron sus listeners.

Una línea, una interceptación. Algunos plugins de chat lanzan el evento una segunda vez para la misma línea. Una repetición de una línea que esta interceptación se quedó, del mismo jugador dentro de 250 ms, se cancela sin volver a preguntarle, así que un canal de staff nunca la dice dos veces.

La interceptación corre en el hilo del chat: lee estado compartido, y salta con Tasks antes de tocar el mundo.

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