io.papermc.paper.chat

Interface ChatFormatter

Functional Interface:

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

Deprecated.

for removal with 1.17, in favour of ChatRenderer

@Deprecated
 @FunctionalInterface
public interface ChatFormatter

A chat formatter is responsible for the formatting of chat messages sent by Players to the server.

Field Summary

Fields

Modifier and Type	Field and Description
static ChatFormatter	DEFAULT Deprecated.

Method Summary

Modifier and Type	Method and Description
@NotNull net.kyori.adventure.text.Component	chat(@NotNull net.kyori.adventure.text.Component displayName, @NotNull net.kyori.adventure.text.Component message) Deprecated. for removal with 1.17

Field Detail

DEFAULT

@Deprecated
static final ChatFormatter DEFAULT

Deprecated.

Method Detail

chat

@Deprecated
 @NotNull
@NotNull net.kyori.adventure.text.Component chat(@NotNull
                                                                       @NotNull net.kyori.adventure.text.Component displayName,
                                                                       @NotNull
                                                                       @NotNull net.kyori.adventure.text.Component message)

Deprecated. for removal with 1.17

Formats a chat message.

Parameters:

displayName - the display name of the Player sending the message

message - the chat message

Returns:

a formatted chat message