ClientChatReceivedEvent.Player (forge 1.20.4)

java.lang.Object

net.minecraftforge.eventbus.api.Event

net.minecraftforge.client.event.ClientChatReceivedEvent

net.minecraftforge.client.event.ClientChatReceivedEvent.Player

Enclosing class:: ClientChatReceivedEvent

public static class ClientChatReceivedEvent.Player extends 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:

ChatType

Nested Class Summary

Nested classes/interfaces inherited from class net.minecraftforge.client.event.ClientChatReceivedEvent
ClientChatReceivedEvent.Player, ClientChatReceivedEvent.System

Nested classes/interfaces inherited from class net.minecraftforge.eventbus.api.Event
net.minecraftforge.eventbus.api.Event.HasResult, net.minecraftforge.eventbus.api.Event.Result
Field Summary

Fields

Modifier and Type

Field

Description

private final PlayerChatMessage

playerChatMessage
Constructor Summary

Constructors

Constructor

Description

Player(ChatType.Bound boundChatType, Component message, PlayerChatMessage playerChatMessage, UUID sender)
Method Summary

Modifier and Type

Method

Description

PlayerChatMessage

getPlayerChatMessage()

Returns the full player chat message.

Methods inherited from class net.minecraftforge.client.event.ClientChatReceivedEvent
getBoundChatType, getMessage, getSender, isSystem, setMessage

Methods inherited from class net.minecraftforge.eventbus.api.Event
getListenerList, getPhase, getResult, hasResult, isCancelable, isCanceled, setCanceled, setPhase, setResult

Methods inherited from class java.lang.Object
clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

Field Details
- playerChatMessage
  
  private final PlayerChatMessage playerChatMessage
Constructor Details
- Player
  
  @Internal public Player(ChatType.Bound boundChatType, Component message, PlayerChatMessage playerChatMessage, UUID sender)
Method Details
- getPlayerChatMessage
  
  public PlayerChatMessage 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