Interface PlayerChatEvent.Submit
- All Superinterfaces:
Cancellable
,Event
,MessageEvent
,PlayerChatEvent
- Enclosing interface:
PlayerChatEvent
Fired when a message is sent by a player.
Note that a signed message cannot be modified.
-
Nested Class Summary
Nested classes/interfaces inherited from interface org.spongepowered.api.event.message.PlayerChatEvent
PlayerChatEvent.Decorate, PlayerChatEvent.Submit
-
Method Summary
Modifier and TypeMethodDescriptionchatType()
Returns the chat type used.filter()
Returns the predicate for filtering the players receiving the message if set.boolean
isSigned()
Returns true whenMessageEvent.originalMessage()
is signed and cannot be modified.sender()
Returns the component to use as the sender.void
setChatType
(RegistryReference<ChatType> chatType) Sets the chat type.void
setFilter
(Predicate<ServerPlayer> filter) Sets the predicate for filtering the players receiving the message.void
Sets the component to use as the sender.void
Sets the component to use as the target.target()
Returns the component to use as the target.Methods inherited from interface org.spongepowered.api.event.Cancellable
isCancelled, setCancelled
Methods inherited from interface org.spongepowered.api.event.message.MessageEvent
message, originalMessage, setMessage
Methods inherited from interface org.spongepowered.api.event.message.PlayerChatEvent
player
-
Method Details
-
filter
Optional<Predicate<ServerPlayer>> filter()Returns the predicate for filtering the players receiving the message if set.- Returns:
- the predicate
-
setFilter
Sets the predicate for filtering the players receiving the message.- Parameters:
filter
- the predicate
-
sender
Component sender()Returns the component to use as the sender. In Vanilla this defaults to the players display name- Returns:
- The sender component
-
setSender
Sets the component to use as the sender.- Parameters:
sender
- The sender component
-
target
Returns the component to use as the target.- Returns:
- The target component
-
setTarget
Sets the component to use as the target.- Parameters:
target
- The target component
-
chatType
RegistryReference<ChatType> chatType()Returns the chat type used.- Returns:
- The chat type
-
setChatType
Sets the chat type. To control the full message format use one ofChatTypes.CUSTOM_CHAT
orChatTypes.CUSTOM_MESSAGE
To modify the chat message itself it is recommended to use
PlayerChatEvent.Decorate
.- Parameters:
chatType
- the chat type to use.
-
isSigned
boolean isSigned()Returns true whenMessageEvent.originalMessage()
is signed and cannot be modified.- Returns:
- True when signed
-