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
FieldsModifier and TypeFieldDescriptionstatic final Map<ResourceLocation,FriendlyByteBuf.Reader<? extends CustomPacketPayload>> private static final intprivate final CustomPacketPayloadThe field for thepayloadrecord component. -
Constructor Summary
ConstructorsConstructorDescriptionClientboundCustomPayloadPacket(FriendlyByteBuf p_295835_) Deprecated.ClientboundCustomPayloadPacket(FriendlyByteBuf buffer, io.netty.channel.ChannelHandlerContext context, ConnectionProtocol protocol) Reads a custom payload packet from the given buffer.Creates an instance of aClientboundCustomPayloadPacketrecord class. -
Method Summary
Modifier and TypeMethodDescriptionfinal booleanIndicates whether some other object is "equal to" this one.voidhandle(ClientCommonPacketListener p_295761_) final inthashCode()Returns a hash code value for this object.payload()Returns the value of thepayloadrecord component.private static CustomPacketPayloadreadPayload(ResourceLocation p_294802_, FriendlyByteBuf p_294886_) Deprecated.UsereadPayload(ResourceLocation, FriendlyByteBuf, io.netty.channel.ChannelHandlerContext, net.minecraft.network.ConnectionProtocol)instead, as this variant can only read vanilla payloads.private static CustomPacketPayloadreadPayload(ResourceLocation p_294367_, FriendlyByteBuf p_294321_, io.netty.channel.ChannelHandlerContext context, ConnectionProtocol protocol) Reads the payload from the given buffer.private static DiscardedPayloadreadUnknownPayload(ResourceLocation p_295991_, FriendlyByteBuf p_295803_) final StringtoString()Returns a string representation of this record class.voidwrite(FriendlyByteBuf p_295630_) Methods inherited from class java.lang.Object
clone, finalize, getClass, notify, notifyAll, wait, wait, waitMethods inherited from interface net.minecraft.network.protocol.Packet
isSkippable, nextProtocol
-
Field Details
-
payload
The field for thepayloadrecord component. -
MAX_PAYLOAD_SIZE
private static final int MAX_PAYLOAD_SIZE- See Also:
-
KNOWN_TYPES
public static final Map<ResourceLocation,FriendlyByteBuf.Reader<? extends CustomPacketPayload>> KNOWN_TYPES
-
-
Constructor Details
-
ClientboundCustomPayloadPacket
Deprecated.UseClientboundCustomPayloadPacket(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 fromcontext- The context of the channel in which this packet is readprotocol- The protocol of the connection
-
ClientboundCustomPayloadPacket
Creates an instance of aClientboundCustomPayloadPacketrecord class.- Parameters:
payload- the value for thepayloadrecord 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 payloadp_294321_- The buffer to read fromcontext- The context of the channel in which this packet is readprotocol- The protocol of the connection- Returns:
- The payload
-
readPayload
@Deprecated private static CustomPacketPayload readPayload(ResourceLocation p_294802_, FriendlyByteBuf p_294886_) Deprecated.UsereadPayload(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
- Specified by:
writein interfacePacket<ClientCommonPacketListener>
-
handle
- Specified by:
handlein interfacePacket<ClientCommonPacketListener>
-
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. -
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. -
equals
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 withObjects::equals(Object,Object). -
payload
Returns the value of thepayloadrecord component.- Returns:
- the value of the
payloadrecord component
-
ClientboundCustomPayloadPacket(FriendlyByteBuf, io.netty.channel.ChannelHandlerContext, net.minecraft.network.ConnectionProtocol)instead, as this variant can only read vanilla payloads.