Record Class ClientboundCustomPayloadPacket

java.lang.Object

java.lang.Record

net.minecraft.network.protocol.common.ClientboundCustomPayloadPacket

All Implemented Interfaces:

Packet<ClientCommonPacketListener>

public record ClientboundCustomPayloadPacket(CustomPacketPayload payload)
extends Record
implements Packet<ClientCommonPacketListener>

Field Summary

Fields

Modifier and Type	Field	Description
static final StreamCodec<FriendlyByteBuf, ClientboundCustomPayloadPacket>	CONFIG_STREAM_CODEC
static final StreamCodec<RegistryFriendlyByteBuf, ClientboundCustomPayloadPacket>	GAMEPLAY_STREAM_CODEC
private static final int	MAX_PAYLOAD_SIZE
private final CustomPacketPayload	payload	The field for the payload record component.

Constructor Summary

Constructors

Constructor	Description
ClientboundCustomPayloadPacket(CustomPacketPayload payload)	Creates an instance of a ClientboundCustomPayloadPacket record class.

Method Summary

Modifier and Type	Method	Description
final boolean	equals(Object o)	Indicates whether some other object is "equal to" this one.
void	handle(ClientCommonPacketListener listener)	Passes this Packet on to the PacketListener for processing.
final int	hashCode()	Returns a hash code value for this object.
CustomPacketPayload	payload()	Returns the value of the payload record component.
final String	toString()	Returns a string representation of this record class.
PacketType<ClientboundCustomPayloadPacket>	type()

Methods inherited from class Object

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

Methods inherited from interface Packet

isSkippable, isTerminal

Field Details

payload

private final CustomPacketPayload payload

The field for the payload record component.

MAX_PAYLOAD_SIZE

private static final int MAX_PAYLOAD_SIZE

See Also:

• Constant Field Values

GAMEPLAY_STREAM_CODEC

public static final StreamCodec<RegistryFriendlyByteBuf, ClientboundCustomPayloadPacket> GAMEPLAY_STREAM_CODEC

CONFIG_STREAM_CODEC

public static final StreamCodec<FriendlyByteBuf, ClientboundCustomPayloadPacket> CONFIG_STREAM_CODEC

Constructor Details

ClientboundCustomPayloadPacket

public ClientboundCustomPayloadPacket(CustomPacketPayload payload)

Creates an instance of a ClientboundCustomPayloadPacket record class.

Parameters:

payload - the value for the payload record component

Method Details

type

public PacketType<ClientboundCustomPayloadPacket> type()

Specified by:

type in interface Packet<ClientCommonPacketListener>

handle

public void handle(ClientCommonPacketListener listener)

Description copied from interface: Packet

Passes this Packet on to the PacketListener for processing.

Specified by:

handle in interface Packet<ClientCommonPacketListener>

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.

payload

public CustomPacketPayload payload()

Returns the value of the payload record component.

Returns:

the value of the payload record component