Package net.neoforged.neoforge.network.registration

Record Class ModdedPlayPayloadRegistration<T extends net.minecraft.network.protocol.common.custom.CustomPacketPayload>

java.lang.Object
java.lang.Record
net.neoforged.neoforge.network.registration.ModdedPlayPayloadRegistration<T>
Type Parameters:
T - The type of payload.
Record Components:
id - The id of the payload.
type - The type of payload.
handler - The handler for the payload.
reader - The reader for the payload.
@Internal public record ModdedPlayPayloadRegistration<T extends net.minecraft.network.protocol.common.custom.CustomPacketPayload>(net.minecraft.resources.ResourceLocation id, Class<T extends net.minecraft.network.protocol.common.custom.CustomPacketPayload> type, IPayloadHandler<T extends net.minecraft.network.protocol.common.custom.CustomPacketPayload> handler, net.minecraft.network.codec.StreamCodec<net.minecraft.network.RegistryFriendlyByteBuf,T extends net.minecraft.network.protocol.common.custom.CustomPacketPayload> reader) extends Record
Registration for a custom packet payload. This type holds the negotiated preferredVersion of the payload to use, and the handler for it.

  • Field Summary

    Fields
    Modifier and Type
    Field
    Description
    private final IPayloadHandler<T>
    handler
    The field for the handler record component.
    private final net.minecraft.resources.ResourceLocation
    id
    The field for the id record component.
    private final net.minecraft.network.codec.StreamCodec<net.minecraft.network.RegistryFriendlyByteBuf,T>
    reader
    The field for the reader record component.
    private final Class<T>
    type
    The field for the type record component.

  • Constructor Summary

    Constructors
    Constructor
    Description
    ModdedPlayPayloadRegistration(net.minecraft.resources.ResourceLocation id, Class<T> type, IPayloadHandler<T> handler, net.minecraft.network.codec.StreamCodec<net.minecraft.network.RegistryFriendlyByteBuf,T> reader)
    Creates an instance of a ModdedPlayPayloadRegistration record class.

  • Method Summary

    Modifier and Type
    Method
    Description
    final boolean
    equals(Object o)
    Indicates whether some other object is "equal to" this one.
    IPayloadHandler<T>
    handler()
    Returns the value of the handler record component.
    final int
    hashCode()
    Returns a hash code value for this object.
    net.minecraft.resources.ResourceLocation
    id()
    Returns the value of the id record component.
    net.minecraft.network.codec.StreamCodec<net.minecraft.network.RegistryFriendlyByteBuf,T>
    reader()
    Returns the value of the reader record component.
    final String
    toString()
    Returns a string representation of this record class.
    Class<T>
    type()
    Returns the value of the type record component.

    Methods inherited from class java.lang.Object

    clone, finalize, getClass, notify, notifyAll, wait, wait, wait

  • Field Details

    • id

      private final net.minecraft.resources.ResourceLocation id
      The field for the id record component.

    • type

      private final Class<T extends net.minecraft.network.protocol.common.custom.CustomPacketPayload> type
      The field for the type record component.

    • handler

      private final IPayloadHandler<T extends net.minecraft.network.protocol.common.custom.CustomPacketPayload> handler
      The field for the handler record component.

    • reader

      private final net.minecraft.network.codec.StreamCodec<net.minecraft.network.RegistryFriendlyByteBuf,T extends net.minecraft.network.protocol.common.custom.CustomPacketPayload> reader
      The field for the reader record component.

  • Constructor Details

    • ModdedPlayPayloadRegistration

      public ModdedPlayPayloadRegistration(net.minecraft.resources.ResourceLocation id, Class<T> type, IPayloadHandler<T> handler, net.minecraft.network.codec.StreamCodec<net.minecraft.network.RegistryFriendlyByteBuf,T> reader)
      Creates an instance of a ModdedPlayPayloadRegistration record class.
      Parameters:
      id - the value for the id record component
      type - the value for the type record component
      handler - the value for the handler record component
      reader - the value for the reader record component

  • Method Details

    • 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 net.minecraft.resources.ResourceLocation id()
      Returns the value of the id record component.
      Returns:
      the value of the id record component

    • type

      public Class<T> type()
      Returns the value of the type record component.
      Returns:
      the value of the type record component

    • handler

      public IPayloadHandler<T> handler()
      Returns the value of the handler record component.
      Returns:
      the value of the handler record component

    • reader

      public net.minecraft.network.codec.StreamCodec<net.minecraft.network.RegistryFriendlyByteBuf,T> reader()
      Returns the value of the reader record component.
      Returns:
      the value of the reader record component