Package com.kamikazejam.kamicommon.nms.serializer

Class VersionedComponentSerializer

java.lang.Object

com.kamikazejam.kamicommon.nms.serializer.VersionedComponentSerializer

public class VersionedComponentSerializer
extends Object

Provider for version-specific adventure component wrappers.

This provider selects the appropriate VersionedComponent implementation based on the current Minecraft version, handling the evolution of the adventure api and its integration natively into paper.

See Also:

• VersionedComponent

Constructor Summary

Constructors

Constructor	Description
VersionedComponentSerializer()

Method Summary

Modifier and Type	Method	Description
@NotNull VersionedComponent	deserializeMiniMessage(@NotNull String miniMessage)	Deserialize a MiniMessage string into a VersionedComponent.
@NotNull VersionedComponent	fromInternalComponent(com.kamikazejam.kamicommon.nms.text.kyori.adventure.text.Component component)	Convert a string (treated as plain text) into a VersionedComponent for this version. Does not support any color codes or mini message parsings.
@NotNull VersionedComponent	fromLegacyAmpersand(@NotNull String legacy)	Convert a legacy ampersand (&) string into a VersionedComponent for this version. Will ignore section (§) codes.
@NotNull VersionedComponent	fromLegacySection(@NotNull String legacy)	Convert a legacy section (§) string into a VersionedComponent for this version. Will ignore ampersand (&) codes.
@NotNull VersionedComponent	fromMiniMessage(@NotNull String miniMessage)	Convert a MiniMessage string into a VersionedComponent for this version. Does not convert or support legacy codes (& or §).
@NotNull VersionedComponent	fromPlainText(@NotNull String text)	Convert a string (treated as plain text) into a VersionedComponent for this version. Does not support any color codes or mini message parsings.
@NotNull String	serializeMiniMessage(@NotNull VersionedComponent component)	Serialize a VersionedComponent back into a MiniMessage string.

Methods inherited from class java.lang.Object

clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

Constructor Details

VersionedComponentSerializer

public VersionedComponentSerializer()

Method Details

fromInternalComponent

@NotNull
public @NotNull VersionedComponent fromInternalComponent(@NotNull
 com.kamikazejam.kamicommon.nms.text.kyori.adventure.text.Component component)

Convert a string (treated as plain text) into a VersionedComponent for this version.

Does not support any color codes or mini message parsings. See other methods for those.

fromPlainText

@NotNull
public @NotNull VersionedComponent fromPlainText(@NotNull
 @NotNull String text)

Convert a string (treated as plain text) into a VersionedComponent for this version.

Does not support any color codes or mini message parsings. See other methods for those.

fromMiniMessage

@NotNull
public @NotNull VersionedComponent fromMiniMessage(@NotNull
 @NotNull String miniMessage)

Convert a MiniMessage string into a VersionedComponent for this version.

Does not convert or support legacy codes (& or §). See fromLegacyAmpersand(String) and fromLegacySection(String) for those.

fromLegacyAmpersand

@NotNull
public @NotNull VersionedComponent fromLegacyAmpersand(@NotNull
 @NotNull String legacy)

Convert a legacy ampersand (&) string into a VersionedComponent for this version.

Will ignore section (§) codes. See fromLegacySection(String) for that.

fromLegacySection

@NotNull
public @NotNull VersionedComponent fromLegacySection(@NotNull
 @NotNull String legacy)

Convert a legacy section (§) string into a VersionedComponent for this version.

Will ignore ampersand (&) codes. See fromLegacyAmpersand(String) for that.

serializeMiniMessage

@NotNull
public @NotNull String serializeMiniMessage(@NotNull
 @NotNull VersionedComponent component)

Serialize a VersionedComponent back into a MiniMessage string.

deserializeMiniMessage

@NotNull
public @NotNull VersionedComponent deserializeMiniMessage(@NotNull
 @NotNull String miniMessage)

Deserialize a MiniMessage string into a VersionedComponent.