Record Class FrozenRegistryPayload

java.lang.Object

java.lang.Record

net.neoforged.neoforge.network.payload.FrozenRegistryPayload

Record Components:

registryName - The name of the registry

snapshot - The snapshot of the registry

All Implemented Interfaces:

CustomPacketPayload

@Internal
public record FrozenRegistryPayload(Identifier registryName, RegistrySnapshot snapshot)
extends Record
implements CustomPacketPayload

Packet payload for sending a frozen registry to the client

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
private final Identifier	registryName	The field for the registryName record component.
private final RegistrySnapshot	snapshot	The field for the snapshot record component.
static final StreamCodec<FriendlyByteBuf, FrozenRegistryPayload>	STREAM_CODEC
static final CustomPacketPayload.Type<FrozenRegistryPayload>	TYPE

Constructor Summary

Constructors

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

Methods inherited from class Object

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

Methods inherited from interface CustomPacketPayload

toVanillaClientbound, toVanillaServerbound

Field Details

registryName

private final Identifier registryName

The field for the registryName record component.

snapshot

private final RegistrySnapshot snapshot

The field for the snapshot record component.

TYPE

public static final CustomPacketPayload.Type<FrozenRegistryPayload> TYPE

STREAM_CODEC

public static final StreamCodec<FriendlyByteBuf, FrozenRegistryPayload> STREAM_CODEC

Constructor Details

FrozenRegistryPayload

public FrozenRegistryPayload(Identifier registryName,
 RegistrySnapshot snapshot)

Creates an instance of a FrozenRegistryPayload record class.

Parameters:

registryName - the value for the registryName record component

snapshot - the value for the snapshot record component

Method Details

type

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

registryName

public Identifier registryName()

Returns the value of the registryName record component.

Returns:

the value of the registryName record component

snapshot

public RegistrySnapshot snapshot()

Returns the value of the snapshot record component.

Returns:

the value of the snapshot record component