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>, ICustomPacket<ClientboundCustomPayloadPacket>

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

Field Summary

Fields

Modifier and Type	Field	Description
private 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_300967_)
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.
int	getIndex()
@Nullable FriendlyByteBuf	getInternalData()	Returns a unsafe reference to this packet's internal data.
ResourceLocation	getName()
void	handle(ClientCommonPacketListener p_299773_)
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_298700_, FriendlyByteBuf p_298589_)
private static DiscardedPayload	readUnknownPayload(ResourceLocation p_299265_, FriendlyByteBuf p_297545_)
final String	toString()	Returns a string representation of this record class.
void	write(FriendlyByteBuf p_298655_)

Methods inherited from class java.lang.Object

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

Methods inherited from interface net.minecraftforge.network.ICustomPacket

getDirection, getThis

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

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

Constructor Details

ClientboundCustomPayloadPacket

public ClientboundCustomPayloadPacket(FriendlyByteBuf p_300967_)

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_298700_,
 FriendlyByteBuf p_298589_)

readUnknownPayload

private static DiscardedPayload readUnknownPayload(ResourceLocation p_299265_,
 FriendlyByteBuf p_297545_)

write

public void write(FriendlyByteBuf p_298655_)

Specified by:

write in interface Packet<ClientCommonPacketListener>

handle

public void handle(ClientCommonPacketListener p_299773_)

Specified by:

handle in interface Packet<ClientCommonPacketListener>

getInternalData

@Nullable
public @Nullable FriendlyByteBuf getInternalData()

Description copied from interface: ICustomPacket

Returns a unsafe reference to this packet's internal data. Any modifications to this buffer will be reflected in the main buffer.

Specified by:

getInternalData in interface ICustomPacket<ClientboundCustomPayloadPacket>

getName

public ResourceLocation getName()

Specified by:

getName in interface ICustomPacket<ClientboundCustomPayloadPacket>

getIndex

public int getIndex()

Specified by:

getIndex in interface ICustomPacket<ClientboundCustomPayloadPacket>

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