Package net.neoforged.neoforge.network.payload

Record Class CommonRegisterPayload

java.lang.Object
java.lang.Record
net.neoforged.neoforge.network.payload.CommonRegisterPayload
Record Components:
version - Declared version of all contained channels. Currently unused by NeoForge.
protocol - The ConnectionProtocol of the contained channels. One of "play" or "configuration". Currently NeoForge only expects and sends "play" channels via this payload.
channels - A list of all named channels available for the declared phase.
All Implemented Interfaces:
net.minecraft.network.protocol.common.custom.CustomPacketPayload
@Internal public record CommonRegisterPayload(int version, net.minecraft.network.ConnectionProtocol protocol, Set<net.minecraft.resources.ResourceLocation> channels) extends Record implements net.minecraft.network.protocol.common.custom.CustomPacketPayload
Common Register, used to send play-phase channels during the configuration phase.

  • Nested Class Summary

    Nested classes/interfaces inherited from interface net.minecraft.network.protocol.common.custom.CustomPacketPayload

    net.minecraft.network.protocol.common.custom.CustomPacketPayload.FallbackProvider<B extends net.minecraft.network.FriendlyByteBuf>, net.minecraft.network.protocol.common.custom.CustomPacketPayload.Type<T extends net.minecraft.network.protocol.common.custom.CustomPacketPayload>, net.minecraft.network.protocol.common.custom.CustomPacketPayload.TypeAndCodec<B extends net.minecraft.network.FriendlyByteBuf,T extends net.minecraft.network.protocol.common.custom.CustomPacketPayload>

  • Field Summary

    Fields
    Modifier and Type
    Field
    Description
    private final Set<net.minecraft.resources.ResourceLocation>
    channels
    The field for the channels record component.
    static final net.minecraft.resources.ResourceLocation
    ID
     
    private final net.minecraft.network.ConnectionProtocol
    protocol
    The field for the protocol record component.
    static final net.minecraft.network.codec.StreamCodec<net.minecraft.network.FriendlyByteBuf,CommonRegisterPayload>
    STREAM_CODEC
     
    static final net.minecraft.network.protocol.common.custom.CustomPacketPayload.Type<CommonRegisterPayload>
    TYPE
     
    private final int
    version
    The field for the version record component.

  • Constructor Summary

    Constructors
    Constructor
    Description
    CommonRegisterPayload(int version, net.minecraft.network.ConnectionProtocol protocol, Set<net.minecraft.resources.ResourceLocation> channels)
    Creates an instance of a CommonRegisterPayload record class.

  • Method Summary

    Modifier and Type
    Method
    Description
    Set<net.minecraft.resources.ResourceLocation>
    channels()
    Returns the value of the channels record component.
    final boolean
    equals(Object o)
    Indicates whether some other object is "equal to" this one.
    final int
    hashCode()
    Returns a hash code value for this object.
    net.minecraft.network.ConnectionProtocol
    protocol()
    Returns the value of the protocol record component.
    private static @Nullable net.minecraft.network.ConnectionProtocol
    protocolById(String id)
     
    final String
    toString()
    Returns a string representation of this record class.
    net.minecraft.network.protocol.common.custom.CustomPacketPayload.Type<CommonRegisterPayload>
    type()
     
    int
    version()
    Returns the value of the version record component.

    Methods inherited from class java.lang.Object

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

    Methods inherited from interface net.minecraft.network.protocol.common.custom.CustomPacketPayload

    toVanillaClientbound, toVanillaServerbound

  • Field Details

    • version

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

    • protocol

      private final net.minecraft.network.ConnectionProtocol protocol
      The field for the protocol record component.

    • channels

      private final Set<net.minecraft.resources.ResourceLocation> channels
      The field for the channels record component.

    • ID

      public static final net.minecraft.resources.ResourceLocation ID

    • TYPE

      public static final net.minecraft.network.protocol.common.custom.CustomPacketPayload.Type<CommonRegisterPayload> TYPE

    • STREAM_CODEC

      public static final net.minecraft.network.codec.StreamCodec<net.minecraft.network.FriendlyByteBuf,CommonRegisterPayload> STREAM_CODEC

  • Constructor Details

    • CommonRegisterPayload

      public CommonRegisterPayload(int version, net.minecraft.network.ConnectionProtocol protocol, Set<net.minecraft.resources.ResourceLocation> channels)
      Creates an instance of a CommonRegisterPayload record class.
      Parameters:
      version - the value for the version record component
      protocol - the value for the protocol record component
      channels - the value for the channels record component

  • Method Details

    • type

      public net.minecraft.network.protocol.common.custom.CustomPacketPayload.Type<CommonRegisterPayload> type()
      Specified by:
      type in interface net.minecraft.network.protocol.common.custom.CustomPacketPayload

    • protocolById

      @Nullable private static @Nullable net.minecraft.network.ConnectionProtocol protocolById(String id)

    • 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.

    • version

      public int version()
      Returns the value of the version record component.
      Returns:
      the value of the version record component

    • protocol

      public net.minecraft.network.ConnectionProtocol protocol()
      Returns the value of the protocol record component.
      Returns:
      the value of the protocol record component

    • channels

      public Set<net.minecraft.resources.ResourceLocation> channels()
      Returns the value of the channels record component.
      Returns:
      the value of the channels record component