Package net.neoforged.neoforge.network.payload

Record Class SplitPacketPayload

java.lang.Object

java.lang.Record

net.neoforged.neoforge.network.payload.SplitPacketPayload

Record Components:

payload - The slice of the original packet.

All Implemented Interfaces:

CustomPacketPayload

@Internal
public record SplitPacketPayload(byte[] payload)
extends Record
implements CustomPacketPayload

A payload that is used to split a packet into multiple payloads.

This single payload will contain a slice of the original packet.

Nested Class Summary

Nested classes/interfaces inherited from interface net.minecraft.network.protocol.common.custom.CustomPacketPayload

CustomPacketPayload.FallbackProvider<B extends FriendlyByteBuf>, CustomPacketPayload.Type<T extends CustomPacketPayload>, CustomPacketPayload.TypeAndCodec<B extends FriendlyByteBuf,T extends CustomPacketPayload>

Field Summary

Fields

Modifier and Type	Field	Description
private final byte[]	payload	The field for the payload record component.
static final StreamCodec<FriendlyByteBuf,SplitPacketPayload>	STREAM_CODEC
static final CustomPacketPayload.Type<SplitPacketPayload>	TYPE

Constructor Summary

Constructors

Constructor	Description
SplitPacketPayload(byte[] payload)	Creates an instance of a SplitPacketPayload record class.

Method Summary

Modifier and Type	Method	Description
final boolean	equals(Object o)	Indicates whether some other object is "equal to" this one.
final int	hashCode()	Returns a hash code value for this object.
byte[]	payload()	Returns the value of the payload record component.
final String	toString()	Returns a string representation of this record class.
CustomPacketPayload.Type<SplitPacketPayload>	type()

Methods inherited from class java.lang.Object

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

Field Details

payload

private final byte[] payload

The field for the payload record component.

TYPE

public static final CustomPacketPayload.Type<SplitPacketPayload> TYPE

STREAM_CODEC

public static final StreamCodec<FriendlyByteBuf,SplitPacketPayload> STREAM_CODEC

Constructor Details

SplitPacketPayload

public SplitPacketPayload(byte[] payload)

Creates an instance of a SplitPacketPayload record class.

Parameters:

payload - the value for the payload record component

Method Details

type

public CustomPacketPayload.Type<SplitPacketPayload> type()

Specified by:

type in interface CustomPacketPayload

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 byte[] payload()

Returns the value of the payload record component.

Returns:

the value of the payload record component