Package org.spongepowered.api.event.message

Interface PlayerChatEvent

All Superinterfaces:

Event, MessageEvent

All Known Subinterfaces:

PlayerChatEvent.Decorate, PlayerChatEvent.Submit

public interface PlayerChatEvent
extends MessageEvent

Fired when sending a chat message. To modify the message use PlayerChatEvent.Decorate.

Nested Class Summary

Nested Classes

Modifier and Type	Interface	Description
static interface	PlayerChatEvent.Decorate	Fired when previewing a message by a player or simulating chat
static interface	PlayerChatEvent.Submit	Fired when a message is sent by a player.

Method Summary

Modifier and Type	Method	Description
Optional<ServerPlayer>	player()	Returns the player sending the message.

Methods inherited from interface org.spongepowered.api.event.Event

cause, context, source

Methods inherited from interface org.spongepowered.api.event.message.MessageEvent

message, originalMessage, setMessage

Method Details

player

Optional<ServerPlayer> player()

Returns the player sending the message.

Returns:

The player sending the message