Record Class RegistrySyncPayload

java.lang.Object

java.lang.Record

net.fabricmc.fabric.impl.registry.sync.packet.RegistrySyncPayload

All Implemented Interfaces:

net.minecraft.network.protocol.common.custom.CustomPacketPayload

public record RegistrySyncPayload(Map<net.minecraft.resources.Identifier, it.unimi.dsi.fastutil.objects.Object2IntMap<net.minecraft.resources.Identifier>> registryMap, Map<net.minecraft.resources.Identifier, EnumSet<RegistryAttribute>> registryAttributes)
extends Record
implements net.minecraft.network.protocol.common.custom.CustomPacketPayload

A more optimized method to sync registry ids to client. Produces smaller packets than the old nbt-based method.

This method optimizes the packet in multiple ways:

• Directly writes into the buffer instead of using an nbt;
• Groups all Identifiers with same namespace together and only sends those unique namespaces once for each group;
• Groups consecutive rawIds together and only sends the difference of the first rawId and the last rawId of the bulk before. This is based on the assumption that mods generally register all of their objects at once, therefore making the rawIds somewhat densely packed.

Nested Class Summary

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

net.minecraft.network.protocol.common.custom.CustomPacketPayload.FallbackProvider<B>, net.minecraft.network.protocol.common.custom.CustomPacketPayload.Type<T>, net.minecraft.network.protocol.common.custom.CustomPacketPayload.TypeAndCodec<B,T>

Field Summary

Fields

Modifier and Type	Field	Description
static final net.minecraft.network.codec.StreamCodec<net.minecraft.network.FriendlyByteBuf, RegistrySyncPayload>	CODEC
static final net.minecraft.network.protocol.common.custom.CustomPacketPayload.Type<RegistrySyncPayload>	ID

Constructor Summary

Constructors

Constructor	Description
RegistrySyncPayload(Map<net.minecraft.resources.Identifier, it.unimi.dsi.fastutil.objects.Object2IntMap<net.minecraft.resources.Identifier>> registryMap)
RegistrySyncPayload(Map<net.minecraft.resources.Identifier, it.unimi.dsi.fastutil.objects.Object2IntMap<net.minecraft.resources.Identifier>> registryMap, Map<net.minecraft.resources.Identifier, EnumSet<RegistryAttribute>> registryAttributes)	Creates an instance of a RegistrySyncPayload 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.
Map<net.minecraft.resources.Identifier, EnumSet<RegistryAttribute>>	registryAttributes()	Returns the value of the registryAttributes record component.
Map<net.minecraft.resources.Identifier, it.unimi.dsi.fastutil.objects.Object2IntMap<net.minecraft.resources.Identifier>>	registryMap()	Returns the value of the registryMap record component.
final String	toString()	Returns a string representation of this record class.
net.minecraft.network.protocol.common.custom.CustomPacketPayload.Type<RegistrySyncPayload>	type()

Methods inherited from class Object

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

Methods inherited from interface net.minecraft.network.protocol.common.custom.CustomPacketPayload

toVanillaClientbound, toVanillaServerbound

Field Details

ID

public static final net.minecraft.network.protocol.common.custom.CustomPacketPayload.Type<RegistrySyncPayload> ID

CODEC

public static final net.minecraft.network.codec.StreamCodec<net.minecraft.network.FriendlyByteBuf, RegistrySyncPayload> CODEC

Constructor Details

RegistrySyncPayload

public RegistrySyncPayload(Map<net.minecraft.resources.Identifier, it.unimi.dsi.fastutil.objects.Object2IntMap<net.minecraft.resources.Identifier>> registryMap)

RegistrySyncPayload

public RegistrySyncPayload(Map<net.minecraft.resources.Identifier, it.unimi.dsi.fastutil.objects.Object2IntMap<net.minecraft.resources.Identifier>> registryMap,
 Map<net.minecraft.resources.Identifier, EnumSet<RegistryAttribute>> registryAttributes)

Creates an instance of a RegistrySyncPayload record class.

Parameters:

registryMap - the value for the registryMap record component

registryAttributes - the value for the registryAttributes record component

Method Details

type

public net.minecraft.network.protocol.common.custom.CustomPacketPayload.Type<RegistrySyncPayload> type()

Specified by:

type in interface net.minecraft.network.protocol.common.custom.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.

registryMap

public Map<net.minecraft.resources.Identifier, it.unimi.dsi.fastutil.objects.Object2IntMap<net.minecraft.resources.Identifier>> registryMap()

Returns the value of the registryMap record component.

Returns:

the value of the registryMap record component

registryAttributes

public Map<net.minecraft.resources.Identifier, EnumSet<RegistryAttribute>> registryAttributes()

Returns the value of the registryAttributes record component.

Returns:

the value of the registryAttributes record component