Package net.neoforged.neoforge.network.payload

Record Class ModdedNetworkPayload

java.lang.Object

java.lang.Record

net.neoforged.neoforge.network.payload.ModdedNetworkPayload

Record Components:

configuration - The configuration components.

play - The play components.

All Implemented Interfaces:

CustomPacketPayload

@Internal
public record ModdedNetworkPayload(Set<ModdedNetworkComponent> configuration, Set<ModdedNetworkComponent> play)
extends Record
implements CustomPacketPayload

A payload that contains the modded network configuration and play components.

Field Summary

Fields

Modifier and Type	Field	Description
private final Set<ModdedNetworkComponent>	configuration	The field for the configuration record component.
static final ResourceLocation	ID
private final Set<ModdedNetworkComponent>	play	The field for the play record component.
static final FriendlyByteBuf.Reader<? extends CustomPacketPayload>	READER

Constructor Summary

Constructors

Constructor	Description
ModdedNetworkPayload(Set<ModdedNetworkComponent> configuration, Set<ModdedNetworkComponent> play)	Creates an instance of a ModdedNetworkPayload record class.
ModdedNetworkPayload(FriendlyByteBuf buf)

Method Summary

Modifier and Type	Method	Description
Set<ModdedNetworkComponent>	configuration()	Returns the value of the configuration 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.
ResourceLocation	id()
Set<ModdedNetworkComponent>	play()	Returns the value of the play record component.
final String	toString()	Returns a string representation of this record class.
void	write(FriendlyByteBuf buf)

Methods inherited from class java.lang.Object

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

Field Details

configuration

private final Set<ModdedNetworkComponent> configuration

The field for the configuration record component.

play

private final Set<ModdedNetworkComponent> play

The field for the play record component.

ID

public static final ResourceLocation ID

READER

public static final FriendlyByteBuf.Reader<? extends CustomPacketPayload> READER

Constructor Details

ModdedNetworkPayload

public ModdedNetworkPayload(FriendlyByteBuf buf)

ModdedNetworkPayload

public ModdedNetworkPayload(Set<ModdedNetworkComponent> configuration,
 Set<ModdedNetworkComponent> play)

Creates an instance of a ModdedNetworkPayload record class.

Parameters:

configuration - the value for the configuration record component

play - the value for the play record component

Method Details

write

public void write(FriendlyByteBuf buf)

Specified by:

write in interface CustomPacketPayload

id

public ResourceLocation id()

Specified by:

id in interface CustomPacketPayload

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.

configuration

public Set<ModdedNetworkComponent> configuration()

Returns the value of the configuration record component.

Returns:

the value of the configuration record component

play

public Set<ModdedNetworkComponent> play()

Returns the value of the play record component.

Returns:

the value of the play record component