net.kyori.text.serializer.legacy

Interface LegacyComponentSerializer

All Superinterfaces:

net.kyori.text.serializer.ComponentSerializer<net.kyori.text.Component,net.kyori.text.TextComponent,java.lang.String>

public interface LegacyComponentSerializer
extends net.kyori.text.serializer.ComponentSerializer<net.kyori.text.Component,net.kyori.text.TextComponent,java.lang.String>

A legacy component serializer.

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

Field Summary

Fields

Modifier and Type	Field and Description
static char	CHARACTER The legacy character.
static LegacyComponentSerializer	INSTANCE Deprecated. use legacy()

Method Summary

Modifier and Type	Method and Description
default @NonNull net.kyori.text.TextComponent	deserialize(@NonNull java.lang.String input) Deserialize a component from a String with the legacy character.
@NonNull net.kyori.text.TextComponent	deserialize(@NonNull java.lang.String input, char character) Deserialize a component from a String with the specified character legacy character.
static @NonNull LegacyComponentSerializer	legacy() Gets a component serializer for legacy-based serialization and deserialization.
static @NonNull LegacyComponentSerializer	legacyLinking() Gets a legacy component serializer for legacy serialization and deserialization that detects and makes URLs clickable in chat.
static @NonNull LegacyComponentSerializer	legacyLinking(@NonNull net.kyori.text.format.Style style) Creates a legacy component serializer for legacy-based serialization and deserialization that detects links and applies style.
default @NonNull java.lang.String	serialize(@NonNull net.kyori.text.Component component) Serializes a component into a String with the specified legacy character.
@NonNull java.lang.String	serialize(@NonNull net.kyori.text.Component component, char character) Serializes a component into a String with the specified character legacy character.

Field Detail

INSTANCE

@Deprecated
static final LegacyComponentSerializer INSTANCE

Deprecated. use legacy()

A component serializer for legacy-based serialization and deserialization.

CHARACTER

static final char CHARACTER

The legacy character.

See Also:

Constant Field Values

Method Detail

legacy

static @NonNull LegacyComponentSerializer legacy()

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 legacyLinking().

Returns:

a component serializer for legacy serialization and deserialization

legacyLinking

static @NonNull LegacyComponentSerializer legacyLinking()

Gets a legacy component serializer for legacy serialization and deserialization that detects and makes URLs clickable in chat.

Returns:

a component serializer for legacy serialization and deserialization that detects and makes URLs clickable in chat

legacyLinking

static @NonNull LegacyComponentSerializer legacyLinking(@NonNull net.kyori.text.format.Style style)

Creates a legacy component serializer for legacy-based serialization and deserialization that detects links and applies style.

Parameters:

style - the style to use

Returns:

a legacy component serializer for legacy-based serialization and deserialization that styles links with the specified style

deserialize

default @NonNull net.kyori.text.TextComponent deserialize(@NonNull java.lang.String input)

Deserialize a component from a String with the legacy character.

Specified by:

deserialize in interface net.kyori.text.serializer.ComponentSerializer<net.kyori.text.Component,net.kyori.text.TextComponent,java.lang.String>

Parameters:

input - the input

Returns:

the component

deserialize

@NonNull net.kyori.text.TextComponent deserialize(@NonNull java.lang.String input,
                                                  char character)

Deserialize a component from a String with the specified character legacy character.

Parameters:

input - the input

character - the legacy character

Returns:

the component

serialize

default @NonNull java.lang.String serialize(@NonNull net.kyori.text.Component component)

Serializes a component into a String with the specified legacy character.

Specified by:

serialize in interface net.kyori.text.serializer.ComponentSerializer<net.kyori.text.Component,net.kyori.text.TextComponent,java.lang.String>

Parameters:

component - the component

Returns:

the string

serialize

@NonNull java.lang.String serialize(@NonNull net.kyori.text.Component component,
                                    char character)

Serializes a component into a String with the specified character legacy character.

Parameters:

component - the component

character - the legacy character

Returns:

the string