Package io.papermc.paper.event.player

Class AsyncChatEvent

java.lang.Object

org.bukkit.event.Event

org.bukkit.event.player.PlayerEvent

io.papermc.paper.event.player.AbstractChatEvent

io.papermc.paper.event.player.AsyncChatEvent

All Implemented Interfaces:

Cancellable

@NullMarked
public final class AsyncChatEvent
extends AbstractChatEvent

An event fired when a Player sends a chat message to the server.

This event will sometimes fire synchronously, depending on how it was triggered.

If a player is the direct cause of this event by an incoming packet, this event will be asynchronous. If a plugin triggers this event by compelling a player to chat, this event will be synchronous.

Care should be taken to check Event.isAsynchronous() and treat the event appropriately.

Nested Class Summary

Nested classes/interfaces inherited from class org.bukkit.event.Event

Event.Result

Field Summary

Fields inherited from class org.bukkit.event.player.PlayerEvent

player

Constructor Summary

Constructors

Constructor	Description
AsyncChatEvent(boolean async, Player player, Set<net.kyori.adventure.audience.Audience> viewers, ChatRenderer renderer, net.kyori.adventure.text.Component message, net.kyori.adventure.text.Component originalMessage, net.kyori.adventure.chat.SignedMessage signedMessage)

Method Summary

Modifier and Type	Method	Description
static HandlerList	getHandlerList()
HandlerList	getHandlers()

Methods inherited from class io.papermc.paper.event.player.AbstractChatEvent

isCancelled, message, message, originalMessage, renderer, renderer, setCancelled, signedMessage, viewers

Methods inherited from class org.bukkit.event.player.PlayerEvent

getPlayer

Methods inherited from class org.bukkit.event.Event

callEvent, getEventName, isAsynchronous

Methods inherited from class java.lang.Object

clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

Constructor Details

AsyncChatEvent

@Internal
public AsyncChatEvent(boolean async,
 Player player,
 Set<net.kyori.adventure.audience.Audience> viewers,
 ChatRenderer renderer,
 net.kyori.adventure.text.Component message,
 net.kyori.adventure.text.Component originalMessage,
 net.kyori.adventure.chat.SignedMessage signedMessage)

Method Details

getHandlers

public HandlerList getHandlers()

Specified by:

getHandlers in class Event

getHandlerList

public static HandlerList getHandlerList()