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(NetworkPayloadSetup setup)
extends Record
implements CustomPacketPayload

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

Nested Class Summary

Nested classes/interfaces inherited from interface CustomPacketPayload

CustomPacketPayload.FallbackProvider<B>, CustomPacketPayload.Type<T>, CustomPacketPayload.TypeAndCodec<B,T>

Field Summary

Fields

Modifier and Type	Field	Description
static final Identifier	ID
private final NetworkPayloadSetup	setup	The field for the setup record component.
static final StreamCodec<FriendlyByteBuf, ModdedNetworkPayload>	STREAM_CODEC
static final CustomPacketPayload.Type<ModdedNetworkPayload>	TYPE

Constructor Summary

Constructors

Constructor	Description
ModdedNetworkPayload(NetworkPayloadSetup setup)	Creates an instance of a ModdedNetworkPayload record class.

Method Summary

Modifier and Type	Method	Description
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.
NetworkPayloadSetup	setup()	Returns the value of the setup record component.
final String	toString()	Returns a string representation of this record class.
CustomPacketPayload.Type<ModdedNetworkPayload>	type()

Methods inherited from class Object

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

Methods inherited from interface CustomPacketPayload

toVanillaClientbound, toVanillaServerbound

Field Details

setup

private final NetworkPayloadSetup setup

The field for the setup record component.

ID

public static final Identifier ID

TYPE

public static final CustomPacketPayload.Type<ModdedNetworkPayload> TYPE

STREAM_CODEC

public static final StreamCodec<FriendlyByteBuf, ModdedNetworkPayload> STREAM_CODEC

Constructor Details

ModdedNetworkPayload

public ModdedNetworkPayload(NetworkPayloadSetup setup)

Creates an instance of a ModdedNetworkPayload record class.

Parameters:

setup - the value for the setup record component

Method Details

type

public CustomPacketPayload.Type<ModdedNetworkPayload> type()

Specified by:

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

setup

public NetworkPayloadSetup setup()

Returns the value of the setup record component.

Returns:

the value of the setup record component