Package net.neoforged.neoforge.network.payload

Record Class ConfigFilePayload

java.lang.Object
java.lang.Record
net.neoforged.neoforge.network.payload.ConfigFilePayload
Record Components:
contents - The contents of the config file.
fileName - The name of the config file.
All Implemented Interfaces:
CustomPacketPayload
@Internal public record ConfigFilePayload(byte[] contents, String fileName) extends Record implements CustomPacketPayload
A payload that contains a config file.

This is used to send config files to the client.

  • Field Details

    • contents

      private final byte[] contents
      The field for the contents record component.

    • fileName

      private final String fileName
      The field for the fileName record component.

    • ID

      public static final ResourceLocation ID

  • Constructor Details

    • ConfigFilePayload

      public ConfigFilePayload(FriendlyByteBuf buf)

    • ConfigFilePayload

      public ConfigFilePayload(byte[] contents, String fileName)
      Creates an instance of a ConfigFilePayload record class.
      Parameters:
      contents - the value for the contents record component
      fileName - the value for the fileName record component

  • Method Details

    • write

      public void write(FriendlyByteBuf buf)
      Specified by:
      write in interface CustomPacketPayload

    • id

      public ResourceLocation id()
      Specified by:
      id in interface CustomPacketPayload

    • toString

      public final String toString()
      Returns a string representation of this record class. The representation contains the name of the class, followed by the name and value of each of the record components.
      Specified by:
      toString in class Record
      Returns:
      a string representation of this object

    • hashCode

      public final int hashCode()
      Returns a hash code value for this object. The value is derived from the hash code of each of the record components.
      Specified by:
      hashCode in class Record
      Returns:
      a hash code value for this object

    • equals

      public final boolean equals(Object o)
      Indicates whether some other object is "equal to" this one. The objects are equal if the other object is of the same class and if all the record components are equal. All components in this record class are compared with Objects::equals(Object,Object).
      Specified by:
      equals in class Record
      Parameters:
      o - the object with which to compare
      Returns:
      true if this object is the same as the o argument; false otherwise.

    • contents

      public byte[] contents()
      Returns the value of the contents record component.
      Returns:
      the value of the contents record component

    • fileName

      public String fileName()
      Returns the value of the fileName record component.
      Returns:
      the value of the fileName record component