Package net.neoforged.neoforge.common.extensions

Interface IFriendlyByteBufExtension

public interface IFriendlyByteBufExtension
Additional helper methods for FriendlyByteBuf.

  • Method Summary

    Modifier and Type
    Method
    Description
    default <T> T[]
    readArray(IntFunction<T[]> builder, net.minecraft.network.codec.StreamDecoder<? super net.minecraft.network.FriendlyByteBuf,T> reader)
    Reads an array of objects from the buffer.
    default <K, V> Map<K,V>
    readMap(net.minecraft.network.codec.StreamDecoder<? super net.minecraft.network.FriendlyByteBuf,K> keyReader, BiFunction<net.minecraft.network.FriendlyByteBuf,K,V> valueReader)
    Variant of FriendlyByteBuf.readMap(StreamDecoder, StreamDecoder) that allows reading values that depend on the key.
    private net.minecraft.network.FriendlyByteBuf
    self()
     
    default <T> net.minecraft.network.FriendlyByteBuf
    writeArray(T[] array, net.minecraft.network.codec.StreamEncoder<? super net.minecraft.network.FriendlyByteBuf,T> writer)
    Writes an array of objects to the buffer.
    default net.minecraft.network.FriendlyByteBuf
    writeByte(byte value)
    Writes a byte to the buffer
    default <K, V> void
    writeMap(Map<K,V> map, net.minecraft.network.codec.StreamEncoder<? super net.minecraft.network.FriendlyByteBuf,K> keyWriter, org.apache.commons.lang3.function.TriConsumer<net.minecraft.network.FriendlyByteBuf,K,V> valueWriter)
    Variant of FriendlyByteBuf.writeMap(Map, StreamEncoder, StreamEncoder) that allows writing values that depend on the key.
    default <T> void
    writeObjectCollection(Collection<T> set, BiConsumer<T,net.minecraft.network.FriendlyByteBuf> writer)
    Writes the entries in the given set to the buffer, by first writing the count and then writing each entry.

  • Method Details

    • self

      private net.minecraft.network.FriendlyByteBuf self()

    • writeObjectCollection

      default <T> void writeObjectCollection(Collection<T> set, BiConsumer<T,net.minecraft.network.FriendlyByteBuf> writer)
      Writes the entries in the given set to the buffer, by first writing the count and then writing each entry.
      Type Parameters:
      T - The type of the entry
      Parameters:
      set - The set to write
      writer - The writer to use for writing each entry

    • readArray

      default <T> T[] readArray(IntFunction<T[]> builder, net.minecraft.network.codec.StreamDecoder<? super net.minecraft.network.FriendlyByteBuf,T> reader)
      Reads an array of objects from the buffer.
      Type Parameters:
      T - The type of the objects
      Parameters:
      builder - A function that creates an array of the given size
      reader - A function that reads an object from the buffer
      Returns:
      The array of objects

    • writeArray

      default <T> net.minecraft.network.FriendlyByteBuf writeArray(T[] array, net.minecraft.network.codec.StreamEncoder<? super net.minecraft.network.FriendlyByteBuf,T> writer)
      Writes an array of objects to the buffer.
      Type Parameters:
      T - The type of the objects
      Parameters:
      array - The array of objects
      writer - A function that writes an object to the buffer
      Returns:
      The buffer

    • writeByte

      default net.minecraft.network.FriendlyByteBuf writeByte(byte value)
      Writes a byte to the buffer
      Parameters:
      value - The value to be written
      Returns:
      The buffer

    • readMap

      default <K, V> Map<K,V> readMap(net.minecraft.network.codec.StreamDecoder<? super net.minecraft.network.FriendlyByteBuf,K> keyReader, BiFunction<net.minecraft.network.FriendlyByteBuf,K,V> valueReader)
      Variant of FriendlyByteBuf.readMap(StreamDecoder, StreamDecoder) that allows reading values that depend on the key.

    • writeMap

      default <K, V> void writeMap(Map<K,V> map, net.minecraft.network.codec.StreamEncoder<? super net.minecraft.network.FriendlyByteBuf,K> keyWriter, org.apache.commons.lang3.function.TriConsumer<net.minecraft.network.FriendlyByteBuf,K,V> valueWriter)
      Variant of FriendlyByteBuf.writeMap(Map, StreamEncoder, StreamEncoder) that allows writing values that depend on the key.