Package net.kyori.adventure.text.serializer.legacy

Interface LegacyComponentSerializer

All Superinterfaces:

Buildable<LegacyComponentSerializer,LegacyComponentSerializer.Builder>, ComponentDecoder<String,TextComponent>, ComponentEncoder<Component,String>, ComponentSerializer<Component,TextComponent,String>

public interface LegacyComponentSerializer
extends ComponentSerializer<Component,TextComponent,String>, Buildable<LegacyComponentSerializer,LegacyComponentSerializer.Builder>

A legacy component serializer.

Legacy does not support more complex features such as, but not limited to, ClickEvent and HoverEvent.

Since:

4.0.0

Nested Class Summary

Nested Classes

Modifier and Type	Interface	Description
static interface	LegacyComponentSerializer.Builder	A builder for LegacyComponentSerializer.
static interface	LegacyComponentSerializer.Provider	A LegacyComponentSerializer service provider.

Field Summary

Fields

Modifier and Type	Field	Description
static final char	AMPERSAND_CHAR	The legacy character frequently used by configurations and commands.
static final char	HEX_CHAR	The legacy character used to prefix hex colors.
static final char	SECTION_CHAR	The legacy character used by Minecraft.

Method Summary

Modifier and Type	Method	Description
static @NotNull LegacyComponentSerializer.Builder	builder()	Creates a new LegacyComponentSerializer.Builder.
@NotNull TextComponent	deserialize(@NotNull String input)	Deserialize a component from a legacy String.
static @NotNull LegacyComponentSerializer	legacy(char legacyCharacter)	Gets a component serializer for legacy-based serialization and deserialization.
static @NotNull LegacyComponentSerializer	legacyAmpersand()	Gets a component serializer for legacy-based serialization and deserialization.
static @NotNull LegacyComponentSerializer	legacySection()	Gets a component serializer for legacy-based serialization and deserialization.
static @Nullable LegacyFormat	parseChar(char character)	Converts a legacy character (0123456789abcdefklmnor) to a legacy format, when possible.
@NotNull String	serialize(@NotNull Component component)	Serializes a component into a legacy String.

Methods inherited from interface net.kyori.adventure.util.Buildable

toBuilder

Methods inherited from interface net.kyori.adventure.text.serializer.ComponentSerializer

deseializeOrNull, deserializeOr, deserializeOrNull, serializeOr, serializeOrNull

Field Details

SECTION_CHAR

static final char SECTION_CHAR

The legacy character used by Minecraft. ('§')

Since:

4.0.0

See Also:

• Constant Field Values

AMPERSAND_CHAR

static final char AMPERSAND_CHAR

The legacy character frequently used by configurations and commands. ('&')

Since:

4.0.0

See Also:

• Constant Field Values

HEX_CHAR

static final char HEX_CHAR

The legacy character used to prefix hex colors. ('#')

Since:

4.0.0

See Also:

• Constant Field Values

Method Details

legacySection

@NotNull
static @NotNull LegacyComponentSerializer legacySection()

Gets a component serializer for legacy-based serialization and deserialization. Note that this serializer works exactly like vanilla Minecraft and does not detect any links. If you want to detect and make URLs clickable, use LegacyComponentSerializer.Builder.extractUrls().

The returned serializer uses the section character.

Returns:

a component serializer for legacy serialization and deserialization

Since:

4.0.0

legacyAmpersand

@NotNull
static @NotNull LegacyComponentSerializer legacyAmpersand()

Gets a component serializer for legacy-based serialization and deserialization. Note that this serializer works exactly like vanilla Minecraft and does not detect any links. If you want to detect and make URLs clickable, use LegacyComponentSerializer.Builder.extractUrls().

The returned serializer uses the ampersand character.

Returns:

a component serializer for legacy serialization and deserialization

Since:

4.0.0

legacy

@NotNull
static @NotNull LegacyComponentSerializer legacy(char legacyCharacter)

Gets a component serializer for legacy-based serialization and deserialization. Note that this serializer works exactly like vanilla Minecraft and does not detect any links. If you want to detect and make URLs clickable, use LegacyComponentSerializer.Builder.extractUrls().

Parameters:

legacyCharacter - the legacy character to use

Returns:

a component serializer for legacy serialization and deserialization

Since:

4.0.0

parseChar

@Nullable
static @Nullable LegacyFormat parseChar(char character)

Converts a legacy character (0123456789abcdefklmnor) to a legacy format, when possible.

Parameters:

character - the legacy character

Returns:

the legacy format

Since:

4.0.0

builder

@NotNull
static @NotNull LegacyComponentSerializer.Builder builder()

Creates a new LegacyComponentSerializer.Builder.

Returns:

the builder

Since:

4.0.0

deserialize

@NotNull
@NotNull TextComponent deserialize(@NotNull
 @NotNull String input)

Deserialize a component from a legacy String.

Specified by:

deserialize in interface ComponentDecoder<String,TextComponent>

Specified by:

deserialize in interface ComponentSerializer<Component,TextComponent,String>

Parameters:

input - the input

Returns:

the component

serialize

@NotNull
@NotNull String serialize(@NotNull
 @NotNull Component component)

Serializes a component into a legacy String.

Specified by:

serialize in interface ComponentEncoder<Component,String>

Specified by:

serialize in interface ComponentSerializer<Component,TextComponent,String>

Parameters:

component - the component

Returns:

the string