Interface LegacyComponentSerializer
-
- All Superinterfaces:
net.kyori.adventure.util.Buildable<LegacyComponentSerializer,LegacyComponentSerializer.Builder>
,net.kyori.adventure.text.serializer.ComponentSerializer<net.kyori.adventure.text.Component,net.kyori.adventure.text.TextComponent,String>
public interface LegacyComponentSerializer extends net.kyori.adventure.text.serializer.ComponentSerializer<net.kyori.adventure.text.Component,net.kyori.adventure.text.TextComponent,String>, net.kyori.adventure.util.Buildable<LegacyComponentSerializer,LegacyComponentSerializer.Builder>
A legacy component serializer.Legacy does not support more complex features such as, but not limited to,
ClickEvent
andHoverEvent
.- Since:
- 4.0.0
-
-
Nested Class Summary
Nested Classes Modifier and Type Interface Description static interface
LegacyComponentSerializer.Builder
A builder forLegacyComponentSerializer
.
-
Field Summary
Fields Modifier and Type Field Description static char
AMPERSAND_CHAR
The legacy character frequently used by configurations and commands.static char
HEX_CHAR
The legacy character used to prefix hex colors.static char
SECTION_CHAR
The legacy character used by Minecraft.
-
Method Summary
All Methods Static Methods Instance Methods Abstract Methods Modifier and Type Method Description static @NonNull LegacyComponentSerializer.Builder
builder()
Creates a newLegacyComponentSerializer.Builder
.@NonNull net.kyori.adventure.text.TextComponent
deserialize(@NonNull String input)
Deserialize a component from a legacyString
.static @NonNull LegacyComponentSerializer
legacy(char legacyCharacter)
Gets a component serializer for legacy-based serialization and deserialization.static @NonNull LegacyComponentSerializer
legacyAmpersand()
Gets a component serializer for legacy-based serialization and deserialization.static @NonNull 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.@NonNull String
serialize(@NonNull net.kyori.adventure.text.Component component)
Serializes a component into a legacyString
.
-
-
-
Field Detail
-
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 Detail
-
legacySection
static @NonNull 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, useLegacyComponentSerializer.Builder.extractUrls()
.The returned serializer uses the
section
character.- Returns:
- a component serializer for legacy serialization and deserialization
- Since:
- 4.0.0
-
legacyAmpersand
static @NonNull 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, useLegacyComponentSerializer.Builder.extractUrls()
.The returned serializer uses the
ampersand
character.- Returns:
- a component serializer for legacy serialization and deserialization
- Since:
- 4.0.0
-
legacy
static @NonNull 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, useLegacyComponentSerializer.Builder.extractUrls()
.- Parameters:
legacyCharacter
- the legacy character to use- Returns:
- a component serializer for legacy serialization and deserialization
- Since:
- 4.0.0
-
parseChar
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
static @NonNull LegacyComponentSerializer.Builder builder()
Creates a newLegacyComponentSerializer.Builder
.- Returns:
- the builder
- Since:
- 4.0.0
-
deserialize
@NonNull net.kyori.adventure.text.TextComponent deserialize(@NonNull String input)
Deserialize a component from a legacyString
.- Specified by:
deserialize
in interfacenet.kyori.adventure.text.serializer.ComponentSerializer<net.kyori.adventure.text.Component,net.kyori.adventure.text.TextComponent,String>
- Parameters:
input
- the input- Returns:
- the component
-
serialize
@NonNull String serialize(@NonNull net.kyori.adventure.text.Component component)
Serializes a component into a legacyString
.- Specified by:
serialize
in interfacenet.kyori.adventure.text.serializer.ComponentSerializer<net.kyori.adventure.text.Component,net.kyori.adventure.text.TextComponent,String>
- Parameters:
component
- the component- Returns:
- the string
-
-