Record Class CommonVersionPayload

java.lang.Object

java.lang.Record

net.neoforged.neoforge.network.payload.CommonVersionPayload

Record Components:

versions - A list of all versions supported by the sender.

All Implemented Interfaces:

CustomPacketPayload

@Internal
public record CommonVersionPayload(List<Integer> versions)
extends Record
implements CustomPacketPayload

Common version payload. Negotiates that the other side supports the same underlying implementation of `c:register` as we do.

See Also:

• NetworkRegistry.SUPPORTED_COMMON_NETWORKING_VERSIONS

Nested Class Summary

Nested classes/interfaces inherited from interface CustomPacketPayload

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

Field Summary

Fields

Modifier and Type	Field	Description
static final Identifier	ID
static final StreamCodec<FriendlyByteBuf, CommonVersionPayload>	STREAM_CODEC
static final CustomPacketPayload.Type<CommonVersionPayload>	TYPE
private final List<Integer>	versions	The field for the versions record component.

Constructor Summary

Constructors

Constructor	Description
CommonVersionPayload()
CommonVersionPayload(List<Integer> versions)	Creates an instance of a CommonVersionPayload 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.
final String	toString()	Returns a string representation of this record class.
CustomPacketPayload.Type<CommonVersionPayload>	type()
List<Integer>	versions()	Returns the value of the versions record component.

Methods inherited from class Object

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

Methods inherited from interface CustomPacketPayload

toVanillaClientbound, toVanillaServerbound

Field Details

versions

private final List<Integer> versions

The field for the versions record component.

ID

public static final Identifier ID

TYPE

public static final CustomPacketPayload.Type<CommonVersionPayload> TYPE

STREAM_CODEC

public static final StreamCodec<FriendlyByteBuf, CommonVersionPayload> STREAM_CODEC

Constructor Details

CommonVersionPayload

public CommonVersionPayload()

CommonVersionPayload

public CommonVersionPayload(List<Integer> versions)

Creates an instance of a CommonVersionPayload record class.

Parameters:

versions - the value for the versions record component

Method Details

type

public CustomPacketPayload.Type<CommonVersionPayload> 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.

versions

public List<Integer> versions()

Returns the value of the versions record component.

Returns:

the value of the versions record component