Record Class ServerboundCustomPayloadPacket
java.lang.Object
java.lang.Record
net.minecraft.network.protocol.common.ServerboundCustomPayloadPacket
- All Implemented Interfaces:
- Packet<ServerCommonPacketListener>
public record ServerboundCustomPayloadPacket(CustomPacketPayload payload)
extends Record
implements Packet<ServerCommonPacketListener>
- 
Field SummaryFieldsModifier and TypeFieldDescriptionstatic final Map<ResourceLocation,FriendlyByteBuf.Reader<? extends CustomPacketPayload>> private static final intprivate final CustomPacketPayloadThe field for thepayloadrecord component.
- 
Constructor SummaryConstructorsConstructorDescriptionServerboundCustomPayloadPacket(FriendlyByteBuf p_296108_) Deprecated.ServerboundCustomPayloadPacket(FriendlyByteBuf p_296108_, io.netty.channel.ChannelHandlerContext context, ConnectionProtocol protocol) Creates a new packet with a custom payload from the network.Creates an instance of aServerboundCustomPayloadPacketrecord class.
- 
Method SummaryModifier and TypeMethodDescriptionfinal booleanIndicates whether some other object is "equal to" this one.voidhandle(ServerCommonPacketListener p_295862_) final inthashCode()Returns a hash code value for this object.payload()Returns the value of thepayloadrecord component.private static CustomPacketPayloadreadPayload(ResourceLocation p_294367_, FriendlyByteBuf p_294321_) 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_294973_, FriendlyByteBuf p_296037_) final StringtoString()Returns a string representation of this record class.voidwrite(FriendlyByteBuf p_295621_) Methods inherited from class java.lang.Objectclone, finalize, getClass, notify, notifyAll, wait, wait, waitMethods inherited from interface net.minecraft.network.protocol.PacketisSkippable, nextProtocol
- 
Field Details- 
payloadThe field for thepayloadrecord component.
- 
MAX_PAYLOAD_SIZEprivate static final int MAX_PAYLOAD_SIZE- See Also:
 
- 
KNOWN_TYPESpublic static final Map<ResourceLocation,FriendlyByteBuf.Reader<? extends CustomPacketPayload>> KNOWN_TYPES
 
- 
- 
Constructor Details- 
ServerboundCustomPayloadPacketDeprecated.UseServerboundCustomPayloadPacket(FriendlyByteBuf, io.netty.channel.ChannelHandlerContext, net.minecraft.network.ConnectionProtocol)instead, as this variant can only read vanilla payloads.Creates a new packet with a custom payload from the network.- Parameters:
- p_296108_- The buffer to read the packet from.
 
- 
ServerboundCustomPayloadPacketpublic ServerboundCustomPayloadPacket(FriendlyByteBuf p_296108_, io.netty.channel.ChannelHandlerContext context, ConnectionProtocol protocol) Creates a new packet with a custom payload from the network.- Parameters:
- p_296108_- The buffer to read the packet from.
- context- The context of the channel handler
- protocol- The protocol of the connection
 
- 
ServerboundCustomPayloadPacketCreates an instance of aServerboundCustomPayloadPacketrecord class.- Parameters:
- payload- the value for the- payloadrecord component
 
 
- 
- 
Method Details- 
readPayloadprivate 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 handler
- protocol- The protocol of the connection
- Returns:
- The payload
 
- 
readPayload@Deprecated private static CustomPacketPayload readPayload(ResourceLocation p_294367_, FriendlyByteBuf p_294321_) Deprecated.UsereadPayload(ResourceLocation, FriendlyByteBuf, io.netty.channel.ChannelHandlerContext, net.minecraft.network.ConnectionProtocol)instead, as this variant can only read vanilla payloads.Reads the payload from the given buffer.- Parameters:
- p_294367_- The id of the payload
- p_294321_- The buffer to read from
- Returns:
- The payload
 
- 
readUnknownPayloadprivate static DiscardedPayload readUnknownPayload(ResourceLocation p_294973_, FriendlyByteBuf p_296037_) 
- 
write- Specified by:
- writein interface- Packet<ServerCommonPacketListener>
 
- 
handle- Specified by:
- handlein interface- Packet<ServerCommonPacketListener>
 
- 
toStringReturns 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.
- 
hashCodepublic 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.
- 
equalsIndicates 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).
- 
payloadReturns the value of thepayloadrecord component.- Returns:
- the value of the payloadrecord component
 
 
- 
ServerboundCustomPayloadPacket(FriendlyByteBuf, io.netty.channel.ChannelHandlerContext, net.minecraft.network.ConnectionProtocol)instead, as this variant can only read vanilla payloads.