Package net.fabricmc.fabric.api.client.message.v1

Interface ClientReceiveMessageEvents.AllowChat

Enclosing class:

ClientReceiveMessageEvents

Functional Interface:

This is a functional interface and can therefore be used as the assignment target for a lambda expression or method reference.

@FunctionalInterface
public static interface ClientReceiveMessageEvents.AllowChat

Method Summary

Modifier and Type	Method	Description
boolean	allowReceiveChatMessage(Text message, @Nullable SignedMessage signedMessage, @Nullable com.mojang.authlib.GameProfile sender, MessageType.Parameters params, Instant receptionTimestamp)	Called when the client receives a chat message, which is any message sent by a player.

Method Details

allowReceiveChatMessage

boolean allowReceiveChatMessage(Text message,
 @Nullable
 @Nullable SignedMessage signedMessage,
 @Nullable
 @Nullable com.mojang.authlib.GameProfile sender,
 MessageType.Parameters params,
 Instant receptionTimestamp)

Called when the client receives a chat message, which is any message sent by a player. Returning false prevents the message from being displayed, and ClientReceiveMessageEvents.CHAT_CANCELED will be triggered instead of ClientReceiveMessageEvents.CHAT.

Parameters:

message - the message received from the server

signedMessage - the signed message received from the server (nullable)

sender - the sender of the message (nullable)

params - the parameters of the message

receptionTimestamp - the timestamp when the message was received

Returns:

true if the message should be displayed, otherwise false