Record Class FrozenRegistrySyncStartPayload

java.lang.Object

java.lang.Record

net.neoforged.neoforge.network.payload.FrozenRegistrySyncStartPayload

Record Components:

toAccess - The registries to access.

All Implemented Interfaces:

CustomPacketPayload

@Internal
public record FrozenRegistrySyncStartPayload(List<Identifier> toAccess)
extends Record
implements CustomPacketPayload

Packet payload sent to the client to start the frozen registry sync.

It indicates to the client which registries it should expect to receive.

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 StreamCodec<FriendlyByteBuf, FrozenRegistrySyncStartPayload>	STREAM_CODEC
private final List<Identifier>	toAccess	The field for the toAccess record component.
static final CustomPacketPayload.Type<FrozenRegistrySyncStartPayload>	TYPE

Constructor Summary

Constructors

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

Methods inherited from class Object

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

Methods inherited from interface CustomPacketPayload

toVanillaClientbound, toVanillaServerbound

Field Details

toAccess

private final List<Identifier> toAccess

The field for the toAccess record component.

TYPE

public static final CustomPacketPayload.Type<FrozenRegistrySyncStartPayload> TYPE

STREAM_CODEC

public static final StreamCodec<FriendlyByteBuf, FrozenRegistrySyncStartPayload> STREAM_CODEC

Constructor Details

FrozenRegistrySyncStartPayload

public FrozenRegistrySyncStartPayload(List<Identifier> toAccess)

Creates an instance of a FrozenRegistrySyncStartPayload record class.

Parameters:

toAccess - the value for the toAccess record component

Method Details

type

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

toAccess

public List<Identifier> toAccess()

Returns the value of the toAccess record component.

Returns:

the value of the toAccess record component