Package net.minecraft.network.protocol.common

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 Map<ResourceLocation,FriendlyByteBuf.Reader<? extends CustomPacketPayload>>	KNOWN_TYPES
private static final int	MAX_PAYLOAD_SIZE
private final CustomPacketPayload	payload	The field for the payload record component.

Constructor Summary

Constructors

Constructor	Description
ClientboundCustomPayloadPacket(FriendlyByteBuf p_295835_)	Deprecated. Use ClientboundCustomPayloadPacket(FriendlyByteBuf, io.netty.channel.ChannelHandlerContext, net.minecraft.network.ConnectionProtocol) instead, as this variant can only read vanilla payloads.
ClientboundCustomPayloadPacket(FriendlyByteBuf buffer, io.netty.channel.ChannelHandlerContext context, ConnectionProtocol protocol)	Reads a custom payload packet from the given buffer.
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 p_295761_)
final int	hashCode()	Returns a hash code value for this object.
CustomPacketPayload	payload()	Returns the value of the payload record component.
private static CustomPacketPayload	readPayload(ResourceLocation p_294802_, FriendlyByteBuf p_294886_)	Deprecated. Use readPayload(ResourceLocation, FriendlyByteBuf, io.netty.channel.ChannelHandlerContext, net.minecraft.network.ConnectionProtocol) instead, as this variant can only read vanilla payloads.
private static CustomPacketPayload	readPayload(ResourceLocation p_294367_, FriendlyByteBuf p_294321_, io.netty.channel.ChannelHandlerContext context, ConnectionProtocol protocol)	Reads the payload from the given buffer.
private static DiscardedPayload	readUnknownPayload(ResourceLocation p_295991_, FriendlyByteBuf p_295803_)
final String	toString()	Returns a string representation of this record class.
void	write(FriendlyByteBuf p_295630_)

Methods inherited from class java.lang.Object

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

Methods inherited from interface net.minecraft.network.protocol.Packet

isSkippable, nextProtocol

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

KNOWN_TYPES

public static final Map<ResourceLocation,FriendlyByteBuf.Reader<? extends CustomPacketPayload>> KNOWN_TYPES

Constructor Details

ClientboundCustomPayloadPacket

@Deprecated
public ClientboundCustomPayloadPacket(FriendlyByteBuf p_295835_)

Deprecated.

Use ClientboundCustomPayloadPacket(FriendlyByteBuf, io.netty.channel.ChannelHandlerContext, net.minecraft.network.ConnectionProtocol) instead, as this variant can only read vanilla payloads.

ClientboundCustomPayloadPacket

public ClientboundCustomPayloadPacket(FriendlyByteBuf buffer,
 io.netty.channel.ChannelHandlerContext context,
 ConnectionProtocol protocol)

Reads a custom payload packet from the given buffer.

Parameters:

buffer - The buffer to read from

context - The context of the channel in which this packet is read

protocol - The protocol of the connection

ClientboundCustomPayloadPacket

public ClientboundCustomPayloadPacket(CustomPacketPayload payload)

Creates an instance of a ClientboundCustomPayloadPacket record class.

Parameters:

payload - the value for the payload record component

Method Details

readPayload

private static CustomPacketPayload readPayload(ResourceLocation p_294367_,
 FriendlyByteBuf p_294321_,
 io.netty.channel.ChannelHandlerContext context,
 ConnectionProtocol protocol)

Reads the payload from the given buffer.

Parameters:

p_294367_ - The id of the payload

p_294321_ - The buffer to read from

context - The context of the channel in which this packet is read

protocol - The protocol of the connection

Returns:

The payload

readPayload

@Deprecated
private static CustomPacketPayload readPayload(ResourceLocation p_294802_,
 FriendlyByteBuf p_294886_)

Deprecated.

Use readPayload(ResourceLocation, FriendlyByteBuf, io.netty.channel.ChannelHandlerContext, net.minecraft.network.ConnectionProtocol) instead, as this variant can only read vanilla payloads.

readUnknownPayload

private static DiscardedPayload readUnknownPayload(ResourceLocation p_295991_,
 FriendlyByteBuf p_295803_)

write

public void write(FriendlyByteBuf p_295630_)

Specified by:

write in interface Packet<ClientCommonPacketListener>

handle

public void handle(ClientCommonPacketListener p_295761_)

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