Package com.velocitypowered.api.event.player

Class PlayerChatEventImpl

java.lang.Object

com.velocitypowered.api.event.player.PlayerChatEventImpl

All Implemented Interfaces:

Event, PlayerChatEvent, ResultedEvent<ResultedEvent.GenericResult>

public final class PlayerChatEventImpl
extends Object
implements PlayerChatEvent

This event is fired when a player types in a chat message.

Nested Class Summary

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

ResultedEvent.ComponentResult, ResultedEvent.GenericResult, ResultedEvent.Result

Constructor Summary

Constructors

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

Method Summary

Modifier and Type	Method	Description
String	currentMessage()	Returns the message currently being sent, which may be modified by plugins.
String	originalMessage()	Returns the message the player originally sent.
Player	player()	Returns the player sending the message.
ResultedEvent.GenericResult	result()	Returns the result associated with this event.
void	setCurrentMessage(String currentMessage)	Sets a new message to send, if the message is allowed to be sent.
void	setResult(ResultedEvent.GenericResult result)	Sets the result of this event.
String	toString()

Methods inherited from class java.lang.Object

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

Constructor Detail

PlayerChatEventImpl

public PlayerChatEventImpl(Player player,
                           String message)

Constructs a PlayerChatEvent.

Parameters:

player - the player sending the message

message - the message being sent

Method Detail

player

public Player player()

Description copied from interface: PlayerChatEvent

Returns the player sending the message.

Specified by:

player in interface PlayerChatEvent

Returns:

the player sending the message

originalMessage

public String originalMessage()

Description copied from interface: PlayerChatEvent

Returns the message the player originally sent.

Specified by:

originalMessage in interface PlayerChatEvent

Returns:

the message the player originally sent

currentMessage

public String currentMessage()

Description copied from interface: PlayerChatEvent

Returns the message currently being sent, which may be modified by plugins.

Specified by:

currentMessage in interface PlayerChatEvent

Returns:

the message currently being sent

setCurrentMessage

public void setCurrentMessage(String currentMessage)

Description copied from interface: PlayerChatEvent

Sets a new message to send, if the message is allowed to be sent.

Specified by:

setCurrentMessage in interface PlayerChatEvent

Parameters:

currentMessage - the message to send instead of the current (or original) message

result

public ResultedEvent.GenericResult result()

Description copied from interface: ResultedEvent

Returns the result associated with this event.

Specified by:

result in interface ResultedEvent<ResultedEvent.GenericResult>

Returns:

the result of this event

setResult

public void setResult(ResultedEvent.GenericResult result)

Description copied from interface: ResultedEvent

Sets the result of this event. The result must be non-null.

Specified by:

setResult in interface ResultedEvent<ResultedEvent.GenericResult>

Parameters:

result - the new result

toString

public String toString()

Overrides:

toString in class Object