Package net.neoforged.neoforge.event

Class ServerChatEvent

java.lang.Object

net.neoforged.bus.api.Event

net.neoforged.neoforge.event.ServerChatEvent

All Implemented Interfaces:

net.neoforged.bus.api.ICancellableEvent

public class ServerChatEvent
extends net.neoforged.bus.api.Event
implements net.neoforged.bus.api.ICancellableEvent

This event is fired whenever a ServerboundChatPacket is received from a client who has submitted their chat message.

This event is cancellable, and does not

invalid reference

have a result

. If the event is cancelled, the message will not be sent to clients.

This event is fired on the main Forge event bus, only on the logical server.

Field Summary

Fields

Modifier and Type	Field	Description
private Component	message
private final ServerPlayer	player
private final String	rawText
private final String	username

Constructor Summary

Constructors

Constructor	Description
ServerChatEvent(ServerPlayer player, String rawText, Component message)

Method Summary

Modifier and Type	Method	Description
Component	getMessage()	Returns the message that will be sent to the relevant clients, if the event is not cancelled.
ServerPlayer	getPlayer()	Returns the player who initiated the chat action.
String	getRawText()	Returns the original raw text of the player chat message.
String	getUsername()	Returns the username of the player who initiated the chat action.
void	setMessage(Component message)	Set the message to be sent to the relevant clients.

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

player

private final ServerPlayer player

username

private final String username

rawText

private final String rawText

message

private Component message

Constructor Details

ServerChatEvent

@Internal
public ServerChatEvent(ServerPlayer player,
 String rawText,
 Component message)

Method Details

getPlayer

public ServerPlayer getPlayer()

Returns the player who initiated the chat action.

Returns:

the player who initiated the chat action

getUsername

public String getUsername()

Returns the username of the player who initiated the chat action.

Returns:

the username of the player who initiated the chat action

getRawText

public String getRawText()

Returns the original raw text of the player chat message.

Returns:

the original raw text of the player chat message

setMessage

public void setMessage(Component message)

Set the message to be sent to the relevant clients.

getMessage

public Component getMessage()

Returns the message that will be sent to the relevant clients, if the event is not cancelled.

Returns:

the message that will be sent to the relevant clients, if the event is not cancelled