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 Summary
Modifier and TypeFieldDescriptionstatic final Map<ResourceLocation,
FriendlyByteBuf.Reader<? extends CustomPacketPayload>> private static final int
private final CustomPacketPayload
The field for thepayload
record component. -
Constructor Summary
ConstructorDescriptionServerboundCustomPayloadPacket
(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 aServerboundCustomPayloadPacket
record class. -
Method Summary
Modifier and TypeMethodDescriptionfinal boolean
Indicates whether some other object is "equal to" this one.void
handle
(ServerCommonPacketListener p_295862_) final int
hashCode()
Returns a hash code value for this object.payload()
Returns the value of thepayload
record component.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.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_294973_, FriendlyByteBuf p_296037_) final String
toString()
Returns a string representation of this record class.void
write
(FriendlyByteBuf p_295621_) 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
The field for thepayload
record 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
-
ServerboundCustomPayloadPacket
Deprecated.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.
-
ServerboundCustomPayloadPacket
public 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 handlerprotocol
- The protocol of the connection
-
ServerboundCustomPayloadPacket
Creates an instance of aServerboundCustomPayloadPacket
record class.- Parameters:
payload
- the value for thepayload
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 payloadp_294321_
- The buffer to read fromcontext
- The context of the channel handlerprotocol
- 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 payloadp_294321_
- The buffer to read from- Returns:
- The payload
-
readUnknownPayload
private static DiscardedPayload readUnknownPayload(ResourceLocation p_294973_, FriendlyByteBuf p_296037_) -
write
- Specified by:
write
in interfacePacket<ServerCommonPacketListener>
-
handle
- Specified by:
handle
in interfacePacket<ServerCommonPacketListener>
-
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 thepayload
record component.- Returns:
- the value of the
payload
record component
-
ServerboundCustomPayloadPacket(FriendlyByteBuf, io.netty.channel.ChannelHandlerContext, net.minecraft.network.ConnectionProtocol)
instead, as this variant can only read vanilla payloads.