Package net.kyori.adventure.platform.facet

Interface Facet.Message<V,M>

Type Parameters:

V - a viewer type

M - a message type

All Superinterfaces:

Facet<V>

All Known Subinterfaces:

Facet.ActionBar<V,M>, Facet.Book<V,M,B>, Facet.Chat<V,M>, Facet.ChatPacket<V,M>, Facet.Title<V,M,T>, Facet.TitlePacket<V,M,T>

All Known Implementing Classes:

ViaFacet, ViaFacet.ActionBar, ViaFacet.ActionBarTitle, ViaFacet.BossBar, ViaFacet.BossBar.Builder, ViaFacet.BossBar.Builder1_9_To_1_15, ViaFacet.Chat, ViaFacet.ProtocolBased, ViaFacet.Title

Enclosing interface:

Facet<V>

public static interface Facet.Message<V,M>
extends Facet<V>

A facet that converts components between formats.

Nested Class Summary

Nested classes/interfaces inherited from interface net.kyori.adventure.platform.facet.Facet

Facet.ActionBar<V,M>, Facet.Book<V,M,B>, Facet.BossBar<V>, Facet.BossBarEntity<V,P>, Facet.BossBarPacket<V>, Facet.Chat<V,M>, Facet.ChatPacket<V,M>, Facet.FakeEntity<V,P>, Facet.Message<V,M>, Facet.Position<V,P>, Facet.Sound<V,P>, Facet.Title<V,M,T>, Facet.TitlePacket<V,M,T>

Field Summary

Fields

Modifier and Type	Field	Description
static int	PROTOCOL_HEX_COLOR
static int	PROTOCOL_JSON

Method Summary

Modifier and Type	Method	Description
@Nullable M	createMessage(@NonNull V viewer, @NonNull net.kyori.adventure.text.Component message)	Creates a message.

Methods inherited from interface net.kyori.adventure.platform.facet.Facet

isApplicable, isSupported

Field Detail

PROTOCOL_HEX_COLOR

static final int PROTOCOL_HEX_COLOR

See Also:

Constant Field Values

PROTOCOL_JSON

static final int PROTOCOL_JSON

See Also:

Constant Field Values

Method Detail

createMessage

@Nullable M createMessage(@NonNull V viewer,
                          @NonNull net.kyori.adventure.text.Component message)

Creates a message.

Messages should not be translated to a viewer's locale, this is done elsewhere.

Parameters:

viewer - a viewer

message - a message

Returns:

a message or null