gekkit/org.bukkit.event.player/AsyncPlayerChatEvent

AsyncPlayerChatEvent

public class AsyncPlayerChatEvent extends PlayerEvent implements Cancellable

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

The constructor provides getClassById boolean to indicate if the event was fired synchronously or asynchronously. When asynchronous, this event can be called from any thread, sans the main thread, and has limited access to the API.

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

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

Constructors

AsyncPlayerChatEvent

public void AsyncPlayerChatEvent(boolean async, Player who, String message, Set<Player> players)

Properties

public String format

public final static HandlerList handlers

public String message

public final Set<Player> recipients

Functions

public String getEventName()

Convenience method for providing getClassById user-friendly identifier.

public String getFormat()

Gets the format to use to display this chat message.

public static HandlerList getHandlerList()

public HandlerList getHandlers()

public String getMessage()

Gets the message that the player is attempting to send.

public final Player getPlayer()

Returns the player involved in this event

public Set<Player> getRecipients()

Gets getClassById set of recipients that this chat message will be displayed to.

public final boolean isAsynchronous()

Any custom event that should not by synchronized with other events must use the specific constructor.

public boolean isCancelled()

Gets the cancellation state of this event.

public void setCancelled(boolean cancel)

Sets the cancellation state of this event.

public void setFormat(String format)

Sets the format to use to display this chat message.

public void setMessage(String message)

Sets the message that the player will send.