Package net.minestom.server.tag

Interface TagSerializer<T>

Type Parameters:
T - the type to serialize
public interface TagSerializer<T>
Interface used to create custom tags.

  • Field Summary

    Fields
    Modifier and Type
    Field
    Description
    static final TagSerializer<net.kyori.adventure.nbt.CompoundBinaryTag>
    COMPOUND
     

  • Method Summary

    Modifier and Type
    Method
    Description
    static <T> TagSerializer<T>
    fromCompound(@NotNull Function<net.kyori.adventure.nbt.CompoundBinaryTag,T> reader, @NotNull Function<T,net.kyori.adventure.nbt.CompoundBinaryTag> writer)
     
    T
    read(@NotNull TagReadable reader)
    Reads the custom tag from a TagReadable.
    void
    write(@NotNull TagWritable writer, T value)
    Writes the custom tag to a TagWritable.

  • Field Details

    • COMPOUND

      @Experimental static final TagSerializer<net.kyori.adventure.nbt.CompoundBinaryTag> COMPOUND

  • Method Details

    • read

      @Nullable T read(@NotNull @NotNull TagReadable reader)
      Reads the custom tag from a TagReadable.
      Parameters:
      reader - the reader
      Returns:
      the deserialized value, null if invalid

    • write

      void write(@NotNull @NotNull TagWritable writer, @NotNull T value)
      Writes the custom tag to a TagWritable.
      Parameters:
      writer - the writer
      value - the value to serialize

    • fromCompound

      @Experimental static <T> TagSerializer<T> fromCompound(@NotNull @NotNull Function<net.kyori.adventure.nbt.CompoundBinaryTag,T> reader, @NotNull @NotNull Function<T,net.kyori.adventure.nbt.CompoundBinaryTag> writer)