Package net.minecraftforge.network

Record Class ForgePayload

java.lang.Object
java.lang.Record
net.minecraftforge.network.ForgePayload
All Implemented Interfaces:
CustomPacketPayload, CustomQueryAnswerPayload, CustomQueryPayload
@Internal public record ForgePayload(ResourceLocation id, @Nullable FriendlyByteBuf data, Consumer<FriendlyByteBuf> encoder) extends Record implements CustomPacketPayload, CustomQueryPayload, CustomQueryAnswerPayload

  • Field Details

    • id

      private final ResourceLocation id
      The field for the id record component.

    • data

      @Nullable private final @Nullable FriendlyByteBuf data
      The field for the data record component.

    • encoder

      private final Consumer<FriendlyByteBuf> encoder
      The field for the encoder record component.

  • Constructor Details

    • ForgePayload

      public ForgePayload(ResourceLocation id, @Nullable @Nullable FriendlyByteBuf data, Consumer<FriendlyByteBuf> encoder)
      Creates an instance of a ForgePayload record class.
      Parameters:
      id - the value for the id record component
      data - the value for the data record component
      encoder - the value for the encoder record component

  • Method Details

    • create

      public static ForgePayload create(ResourceLocation id, FriendlyByteBuf data)

    • create

      public static ForgePayload create(ResourceLocation id, Consumer<FriendlyByteBuf> encoder)

    • write

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

    • type

      public CustomPacketPayload.Type<? extends CustomPacketPayload> type()
      Specified by:
      type 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.

    • id

      public ResourceLocation id()
      Returns the value of the id record component.
      Specified by:
      id in interface CustomQueryPayload
      Returns:
      the value of the id record component

    • data

      @Nullable public @Nullable FriendlyByteBuf data()
      Returns the value of the data record component.
      Returns:
      the value of the data record component

    • encoder

      public Consumer<FriendlyByteBuf> encoder()
      Returns the value of the encoder record component.
      Returns:
      the value of the encoder record component