Package net.neoforged.neoforge.network.payload

Record Class ModdedNetworkQueryComponent

java.lang.Object
java.lang.Record
net.neoforged.neoforge.network.payload.ModdedNetworkQueryComponent
Record Components:
id - The id of the component
version - The version of the component, if present
flow - The flow of the component, if present
optional - Whether the component is optional
@Internal public record ModdedNetworkQueryComponent(net.minecraft.resources.ResourceLocation id, String version, Optional<net.minecraft.network.protocol.PacketFlow> flow, boolean optional) extends Record
Represents a potential modded network component, used for querying the client for modded network components.

  • Field Summary

    Fields
    Modifier and Type
    Field
    Description
    private final Optional<net.minecraft.network.protocol.PacketFlow>
    flow
    The field for the flow record component.
    private final net.minecraft.resources.ResourceLocation
    id
    The field for the id record component.
    private final boolean
    optional
    The field for the optional record component.
    static final net.minecraft.network.codec.StreamCodec<net.minecraft.network.FriendlyByteBuf,ModdedNetworkQueryComponent>
    STREAM_CODEC
     
    private final String
    version
    The field for the version record component.

  • Constructor Summary

    Constructors
    Constructor
    Description
    ModdedNetworkQueryComponent(net.minecraft.resources.ResourceLocation id, String version, Optional<net.minecraft.network.protocol.PacketFlow> flow, boolean optional)
    Creates an instance of a ModdedNetworkQueryComponent record class.
    ModdedNetworkQueryComponent(PayloadRegistration<?> reg)
     

  • Method Summary

    Modifier and Type
    Method
    Description
    final boolean
    equals(Object o)
    Indicates whether some other object is "equal to" this one.
    Optional<net.minecraft.network.protocol.PacketFlow>
    flow()
    Returns the value of the flow 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.
    boolean
    optional()
    Returns the value of the optional record component.
    final String
    toString()
    Returns a string representation of this record class.
    String
    version()
    Returns the value of the version 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.

    • version

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

    • flow

      private final Optional<net.minecraft.network.protocol.PacketFlow> flow
      The field for the flow record component.

    • optional

      private final boolean optional
      The field for the optional record component.

    • STREAM_CODEC

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

  • Constructor Details

    • ModdedNetworkQueryComponent

      public ModdedNetworkQueryComponent(PayloadRegistration<?> reg)

    • ModdedNetworkQueryComponent

      public ModdedNetworkQueryComponent(net.minecraft.resources.ResourceLocation id, String version, Optional<net.minecraft.network.protocol.PacketFlow> flow, boolean optional)
      Creates an instance of a ModdedNetworkQueryComponent record class.
      Parameters:
      id - the value for the id record component
      version - the value for the version record component
      flow - the value for the flow record component
      optional - the value for the optional 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. 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 net.minecraft.resources.ResourceLocation id()
      Returns the value of the id record component.
      Returns:
      the value of the id record component

    • version

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

    • flow

      public Optional<net.minecraft.network.protocol.PacketFlow> flow()
      Returns the value of the flow record component.
      Returns:
      the value of the flow record component

    • optional

      public boolean optional()
      Returns the value of the optional record component.
      Returns:
      the value of the optional record component