Package com.velocitypowered.api.event.player

Class PlayerChatEvent

java.lang.Object

com.velocitypowered.api.event.player.PlayerChatEvent

All Implemented Interfaces:

ResultedEvent<PlayerChatEvent.ChatResult>

@AwaitingEvent
public final class PlayerChatEvent
extends Object
implements ResultedEvent<PlayerChatEvent.ChatResult>

This event is fired when a player types in a chat message. Velocity will wait on this event to finish firing before forwarding it to the server, if the result allows it.

Nested Class Summary

Nested Classes

Modifier and Type	Class	Description
static final class	PlayerChatEvent.ChatResult	Represents the result of the PlayerChatEvent.

Nested classes/interfaces inherited from interface com.velocitypowered.api.event.ResultedEvent

ResultedEvent.ComponentResult, ResultedEvent.GenericResult, ResultedEvent.Result

Constructor Summary

Constructors

Constructor	Description
PlayerChatEvent(Player player, String message)	Constructs a PlayerChatEvent.

Method Summary

Modifier and Type	Method	Description
String	getMessage()	Gets the (possibly modified) chat message to be sent.
Player	getPlayer()	Gets the player who sent the chat message.
PlayerChatEvent.ChatResult	getResult()	Returns the result associated with this event.
void	setResult(PlayerChatEvent.ChatResult result)	Deprecated. for 1.19.1 and newer, set this as denied will kick users
String	toString()

Methods inherited from class java.lang.Object

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

Constructor Details

PlayerChatEvent

public PlayerChatEvent(Player player,
 String message)

Constructs a PlayerChatEvent.

Parameters:

player - the player sending the message

message - the message being sent

Method Details

getPlayer

public Player getPlayer()

Gets the player who sent the chat message.

Returns:

the player who sent the message

getMessage

public String getMessage()

Gets the (possibly modified) chat message to be sent.

Returns:

an Optional containing the message, or empty if none

getResult

public PlayerChatEvent.ChatResult getResult()

Description copied from interface: ResultedEvent

Returns the result associated with this event.

Specified by:

getResult in interface ResultedEvent<PlayerChatEvent.ChatResult>

Returns:

the result of this event

setResult

@Deprecated
public void setResult(PlayerChatEvent.ChatResult result)

Deprecated.

for 1.19.1 and newer, set this as denied will kick users

Set result for the event.

Specified by:

setResult in interface ResultedEvent<PlayerChatEvent.ChatResult>

Parameters:

result - the result of event

toString

public String toString()

Overrides:

toString in class Object