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.

@Internal
public record NetworkPayloadSetup(Map<ConnectionProtocol,Map<ResourceLocation,NetworkChannel>> channels)
extends Record

Represents a complete negotiated network, which is stored on the client and server.

Field Summary

Fields

Modifier and Type	Field	Description
private final Map<ConnectionProtocol,Map<ResourceLocation,NetworkChannel>>	channels	The field for the channels record component.
static StreamCodec<FriendlyByteBuf,NetworkPayloadSetup>	STREAM_CODEC

Constructor Summary

Constructors

Constructor	Description
NetworkPayloadSetup(Map<ConnectionProtocol,Map<ResourceLocation,NetworkChannel>> channels)	Creates an instance of a NetworkPayloadSetup record class.

Method Summary

Modifier and Type	Method	Description
Map<ConnectionProtocol,Map<ResourceLocation,NetworkChannel>>	channels()	Returns the value of the channels record component.
static NetworkPayloadSetup	empty()	Returns An empty modded network..
final boolean	equals(Object o)	Indicates whether some other object is "equal to" this one.
static NetworkPayloadSetup	from(Map<ConnectionProtocol,NegotiationResult> results)	Returns A modded network with the given configuration and play channels..
@Nullable NetworkChannel	getChannel(ConnectionProtocol protocol, ResourceLocation id)
Map<ResourceLocation,NetworkChannel>	getChannels(ConnectionProtocol protocol)
final int	hashCode()	Returns a hash code value for this object.
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

channels

private final Map<ConnectionProtocol,Map<ResourceLocation,NetworkChannel>> channels

The field for the channels record component.

STREAM_CODEC

public static StreamCodec<FriendlyByteBuf,NetworkPayloadSetup> STREAM_CODEC

Constructor Details

NetworkPayloadSetup

public NetworkPayloadSetup(Map<ConnectionProtocol,Map<ResourceLocation,NetworkChannel>> channels)

Creates an instance of a NetworkPayloadSetup record class.

Parameters:

channels - the value for the channels record component

Method Details

getChannels

public Map<ResourceLocation,NetworkChannel> getChannels(ConnectionProtocol protocol)

getChannel

@Nullable
public @Nullable NetworkChannel getChannel(ConnectionProtocol protocol,
 ResourceLocation id)

empty

public static NetworkPayloadSetup empty()

Returns An empty modded network..

Returns:

An empty modded network.

from

public static NetworkPayloadSetup from(Map<ConnectionProtocol,NegotiationResult> results)

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

channels

public Map<ConnectionProtocol,Map<ResourceLocation,NetworkChannel>> channels()

Returns the value of the channels record component.

Returns:

the value of the channels record component