Package net.kyori.adventure.text.serializer.json

Interface LegacyHoverEventSerializer

public interface LegacyHoverEventSerializer
Adapter to convert between modern and legacy hover event formats.
Since:
4.14.0

  • Method Details

    • deserializeShowItem

      @NotNull HoverEvent.ShowItem deserializeShowItem(@NotNull @NotNull Component input) throws IOException
      Convert a legacy hover event show_item value to its modern format.
      Parameters:
      input - component whose plain-text value is a SNBT string
      Returns:
      the deserialized event
      Throws:
      IOException - if the input is improperly formatted
      Since:
      4.14.0

    • serializeShowItem

      @NotNull @NotNull Component serializeShowItem(@NotNull HoverEvent.ShowItem input) throws IOException
      Convert a modern hover event show_item value to its legacy format.
      Parameters:
      input - modern hover event
      Returns:
      component with the legacy value as a SNBT string
      Throws:
      IOException - if the input is improperly formatted
      Since:
      4.14.0

    • deserializeShowEntity

      @NotNull HoverEvent.ShowEntity deserializeShowEntity(@NotNull @NotNull Component input, Codec.Decoder<Component,String,? extends RuntimeException> componentDecoder) throws IOException
      Convert a legacy hover event show_entity value to its modern format.
      Parameters:
      input - component whose plain-text value is a SNBT string
      componentDecoder - A decoder that can take a JSON string and return a deserialized component
      Returns:
      the deserialized event
      Throws:
      IOException - if the input is improperly formatted
      Since:
      4.14.0

    • serializeShowEntity

      @NotNull @NotNull Component serializeShowEntity(@NotNull HoverEvent.ShowEntity input, Codec.Encoder<Component,String,? extends RuntimeException> componentEncoder) throws IOException
      Convert a modern hover event show_entity value to its legacy format.
      Parameters:
      input - modern hover event
      componentEncoder - An encoder that can take a Component and return a JSON string
      Returns:
      component with the legacy value as a SNBT string
      Throws:
      IOException - if the input is improperly formatted
      Since:
      4.14.0