PlayerChatEvent (velocity-api 3.2.0-SNAPSHOT API)

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 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

All Methods Instance Methods Concrete Methods
Modifier and Type	Method	Description
`String`	`getMessage()`
`Player`	`getPlayer()`
`PlayerChatEvent.ChatResult`	`getResult()`	Returns the result associated with this event.
`void`	`setResult(PlayerChatEvent.ChatResult 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
  - PlayerChatEvent
```
public PlayerChatEvent(Player player,
                       String message)
```
    Constructs a PlayerChatEvent.
    
    Parameters:
    
    player - the player sending the message
    
    message - the message being sent
- Method Detail
  - getPlayer
```
public Player getPlayer()
```
  - getMessage
```
public String getMessage()
```
  - 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
```
public void setResult(PlayerChatEvent.ChatResult result)
```
    Description copied from interface: ResultedEvent
    
    Sets the result of this event. The result must be non-null.
    
    Specified by:
    
    setResult in interface ResultedEvent<PlayerChatEvent.ChatResult>
    
    Parameters:
    
    result - the new result
  - toString
```
public String toString()
```
    Overrides:
    
    toString in class Object