Class ClientChatReceivedEvent.Player
java.lang.Object
net.neoforged.bus.api.Event
net.neoforged.neoforge.client.event.ClientChatReceivedEvent
net.neoforged.neoforge.client.event.ClientChatReceivedEvent.Player
- All Implemented Interfaces:
net.neoforged.bus.api.ICancellableEvent
- Enclosing class:
- ClientChatReceivedEvent
Fired when a player chat message is received on the client.
This event is cancellable, and does not have a result. If the event is cancelled, the message is not displayed in the chat message window.
This event is fired on the main Forge event bus, only on the logical client.
- See Also:
-
Nested Class Summary
Nested classes/interfaces inherited from class net.neoforged.neoforge.client.event.ClientChatReceivedEvent
ClientChatReceivedEvent.Player, ClientChatReceivedEvent.System
Nested classes/interfaces inherited from class net.neoforged.bus.api.Event
net.neoforged.bus.api.Event.HasResult, net.neoforged.bus.api.Event.Result
-
Field Summary
-
Constructor Summary
ConstructorDescriptionPlayer
(ChatType.Bound boundChatType, Component message, PlayerChatMessage playerChatMessage, UUID sender) -
Method Summary
Modifier and TypeMethodDescriptionReturns the full player chat message.Methods inherited from class net.neoforged.neoforge.client.event.ClientChatReceivedEvent
getBoundChatType, getMessage, getSender, isSystem, setMessage
Methods inherited from class net.neoforged.bus.api.Event
getResult, hasResult, setResult
Methods inherited from class java.lang.Object
clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait
Methods inherited from interface net.neoforged.bus.api.ICancellableEvent
isCanceled, setCanceled
-
Field Details
-
playerChatMessage
-
-
Constructor Details
-
Player
@Internal public Player(ChatType.Bound boundChatType, Component message, PlayerChatMessage playerChatMessage, UUID sender)
-
-
Method Details
-
getPlayerChatMessage
Returns the full player chat message.. This contains the sender UUID, various signing data, and the optional unsigned contents.- Returns:
- the full player chat message
-