Package net.neoforged.neoforge.network.registration

Record Class NetworkPayloadSetup

java.lang.Object
java.lang.Record
net.neoforged.neoforge.network.registration.NetworkPayloadSetup
Record Components:
configuration - The configuration channels.
play - The play channels.
vanilla - Whether this is a vanilla network.
@Internal public record NetworkPayloadSetup(Map<ResourceLocation,NetworkChannel> configuration, Map<ResourceLocation,NetworkChannel> play, boolean vanilla) extends Record
Represents a complete negotiated network, which is stored on the client and server.

  • Field Details

  • Constructor Details

  • Method Details

    • emptyModded

      public static NetworkPayloadSetup emptyModded()
      Returns An empty modded network..
      Returns:
      An empty modded network.

    • emptyVanilla

      public static NetworkPayloadSetup emptyVanilla()
      Returns An empty vanilla network..
      Returns:
      An empty vanilla network.

    • from

      public static NetworkPayloadSetup from(Set<NetworkChannel> configuration, Set<NetworkChannel> play)
      Returns A modded network with the given configuration and play channels..
      Returns:
      A modded network with the given configuration and play channels.

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

    • configuration

      public Map<ResourceLocation,NetworkChannel> configuration()
      Returns the value of the configuration record component.
      Returns:
      the value of the configuration record component

    • play

      public Map<ResourceLocation,NetworkChannel> play()
      Returns the value of the play record component.
      Returns:
      the value of the play record component

    • vanilla

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