Package net.neoforged.neoforge.network.custom.payload

Record Class SimplePayload

java.lang.Object
java.lang.Record
net.neoforged.neoforge.network.custom.payload.SimplePayload
All Implemented Interfaces:
CustomPacketPayload, ICustomPacketPayloadWithBuffer
public record SimplePayload(FriendlyByteBuf payload, ResourceLocation id, int packetIndex) extends Record implements ICustomPacketPayloadWithBuffer

  • Field Details

    • payload

      private final FriendlyByteBuf payload
      The field for the payload record component.

    • id

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

    • packetIndex

      private final int packetIndex
      The field for the packetIndex record component.

  • Constructor Details

    • SimplePayload

      public SimplePayload(byte[] payload, ResourceLocation id, int packetIndex)

    • SimplePayload

      public SimplePayload(FriendlyByteBuf payload, ResourceLocation id, int packetIndex)
      Creates an instance of a SimplePayload record class.
      Parameters:
      payload - the value for the payload record component
      id - the value for the id record component
      packetIndex - the value for the packetIndex record component

  • Method Details

    • outbound

      public static SimplePayload outbound(byte[] payload, int packetIndex, ResourceLocation id)

    • outbound

      public static SimplePayload outbound(FriendlyByteBuf byteBuf, int packetIndex, ResourceLocation id)

    • inbound

      public static SimplePayload inbound(FriendlyByteBuf byteBuf, ResourceLocation id)

    • write

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

    • buffer

      public FriendlyByteBuf buffer()
      Description copied from interface: ICustomPacketPayloadWithBuffer
      The buffer that created the query payload.
      Specified by:
      buffer in interface ICustomPacketPayloadWithBuffer
      Returns:
      The buffer

    • packetIndex

      public int packetIndex()
      Returns the value of the packetIndex record component.
      Specified by:
      packetIndex in interface ICustomPacketPayloadWithBuffer
      Returns:
      the value of the packetIndex record component

    • payload

      public FriendlyByteBuf payload()
      Returns the value of the payload record component.
      Returns:
      the value of the payload record component

    • 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. Reference components are compared with Objects::equals(Object,Object); primitive components are compared with '=='.
      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 CustomPacketPayload
      Returns:
      the value of the id record component