Package io.papermc.paper.text

Class PaperComponents

java.lang.Object
io.papermc.paper.text.PaperComponents
public final class PaperComponents extends Object
Paper API-specific methods for working with Components and related.

  • Method Details

    • flattener

      public static @NonNull ComponentFlattener flattener()
      Return a component flattener that can use game data to resolve extra information about components.
      Returns:
      a component flattener

    • plainSerializer

      public static @NonNull PlainComponentSerializer plainSerializer()
      Get a serializer for Components that will convert components to a plain-text string.

      Implementations may provide a serializer capable of processing any information that requires access to implementation details.

      Returns:
      a serializer to plain text

    • gsonSerializer

      public static @NonNull GsonComponentSerializer gsonSerializer()
      Get a serializer for Components that will convert to and from the standard JSON serialization format using Gson.

      Implementations may provide a serializer capable of processing any information that requires implementation details, such as legacy (pre-1.16) hover events.

      Returns:
      a json component serializer

    • colorDownsamplingGsonSerializer

      public static @NonNull GsonComponentSerializer colorDownsamplingGsonSerializer()
      Get a serializer for Components that will convert to and from the standard JSON serialization format using Gson, downsampling any RGB colors to their nearest NamedTextColor counterpart.

      Implementations may provide a serializer capable of processing any information that requires implementation details, such as legacy (pre-1.16) hover events.

      Returns:
      a json component serializer

    • legacySectionSerializer

      public static @NonNull LegacyComponentSerializer legacySectionSerializer()
      Get a serializer for Components that will convert to and from the legacy component format used by Bukkit. This serializer uses the LegacyComponentSerializer.Builder.useUnusualXRepeatedCharacterHexFormat() option to match upstream behavior.

      This legacy serializer uses the standard section symbol to mark formatting characters.

      Implementations may provide a serializer capable of processing any information that requires access to implementation details.

      Returns:
      a section serializer