Package net.neoforged.neoforge.network.registration

Record Class NetworkChannel

java.lang.Object
java.lang.Record
net.neoforged.neoforge.network.registration.NetworkChannel
Record Components:
id - The payload id.
chosenVersion - The chosen version, if any.
@Internal public record NetworkChannel(net.minecraft.resources.ResourceLocation id, String chosenVersion) extends Record
Represents a complete negotiated network payload type, which is stored on the client and server.

  • Field Summary

    Fields
    Modifier and Type
    Field
    Description
    private final String
    chosenVersion
    The field for the chosenVersion record component.
    private final net.minecraft.resources.ResourceLocation
    id
    The field for the id record component.
    static final net.minecraft.network.codec.StreamCodec<net.minecraft.network.FriendlyByteBuf,NetworkChannel>
    STREAM_CODEC
     

  • Constructor Summary

    Constructors
    Constructor
    Description
    NetworkChannel(net.minecraft.resources.ResourceLocation id, String chosenVersion)
    Creates an instance of a NetworkChannel record class.

  • Method Summary

    Modifier and Type
    Method
    Description
    String
    chosenVersion()
    Returns the value of the chosenVersion 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.resources.ResourceLocation
    id()
    Returns the value of the id record component.
    final String
    toString()
    Returns a string representation of this record class.

    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.

    • chosenVersion

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

    • STREAM_CODEC

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

  • Constructor Details

    • NetworkChannel

      public NetworkChannel(net.minecraft.resources.ResourceLocation id, String chosenVersion)
      Creates an instance of a NetworkChannel record class.
      Parameters:
      id - the value for the id record component
      chosenVersion - the value for the chosenVersion 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

    • chosenVersion

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