程序包 net.neoforged.neoforge.network.registration

记录类 PayloadRegistration<T extends CustomPacketPayload>

java.lang.Object

java.lang.Record

net.neoforged.neoforge.network.registration.PayloadRegistration<T>

类型参数:

T - The type of the payload

记录组件：

type - The type of the payload

codec - The codec for the payload

protocols - The protocols this payload supports

flow - The flow this payload supports (empty if both)

version - The version of the payload

optional - If the payload is optional

@Internal
public record PayloadRegistration<T extends CustomPacketPayload>(CustomPacketPayload.Type<T extends CustomPacketPayload> type, StreamCodec<? super RegistryFriendlyByteBuf,T extends CustomPacketPayload> codec, List<ConnectionProtocol> protocols, Optional<PacketFlow> flow, String version, boolean optional)
extends Record

Holds the information needed to describe a registered payload.

字段概要

字段

修饰符和类型	字段	说明
private final StreamCodec<? super RegistryFriendlyByteBuf,T>	codec	codec 记录组件的字段。
private final Optional<PacketFlow>	flow	flow 记录组件的字段。
private final boolean	optional	optional 记录组件的字段。
private final List<ConnectionProtocol>	protocols	protocols 记录组件的字段。
private final CustomPacketPayload.Type<T>	type	type 记录组件的字段。
private final String	version	version 记录组件的字段。

构造器概要

构造器

构造器	说明
PayloadRegistration(CustomPacketPayload.Type<T> type, StreamCodec<? super RegistryFriendlyByteBuf,T> codec, List<ConnectionProtocol> protocols, Optional<PacketFlow> flow, String version, boolean optional)	创建 PayloadRegistration 记录类的实例。

方法概要

修饰符和类型	方法	说明
StreamCodec<? super RegistryFriendlyByteBuf,T>	codec()	返回 codec 记录组件的值。
final boolean	equals(Object o)	指示某个其他对象是否“等于”此对象。
Optional<PacketFlow>	flow()	返回 flow 记录组件的值。
final int	hashCode()	返回此对象的哈希代码值。
ResourceLocation	id()
boolean	matchesFlow(PacketFlow flow)	返回 true if the registered flow is compatible with the passed flow。
boolean	optional()	返回 optional 记录组件的值。
List<ConnectionProtocol>	protocols()	返回 protocols 记录组件的值。
final String	toString()	返回此记录类的字符串表示形式。
CustomPacketPayload.Type<T>	type()	返回 type 记录组件的值。
String	version()	返回 version 记录组件的值。

从类继承的方法 java.lang.Object

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

字段详细资料

type

private final CustomPacketPayload.Type<T extends CustomPacketPayload> type

type 记录组件的字段。

codec

private final StreamCodec<? super RegistryFriendlyByteBuf,T extends CustomPacketPayload> codec

codec 记录组件的字段。

protocols

private final List<ConnectionProtocol> protocols

protocols 记录组件的字段。

flow

private final Optional<PacketFlow> flow

flow 记录组件的字段。

version

private final String version

version 记录组件的字段。

optional

private final boolean optional

optional 记录组件的字段。

构造器详细资料

PayloadRegistration

public PayloadRegistration(CustomPacketPayload.Type<T> type,
 StreamCodec<? super RegistryFriendlyByteBuf,T> codec,
 List<ConnectionProtocol> protocols,
 Optional<PacketFlow> flow,
 String version,
 boolean optional)

创建 PayloadRegistration 记录类的实例。

参数:

type - type 记录组件的值

codec - codec 记录组件的值

protocols - protocols 记录组件的值

flow - flow 记录组件的值

version - version 记录组件的值

optional - optional 记录组件的值

方法详细资料

id

public ResourceLocation id()

matchesFlow

public boolean matchesFlow(PacketFlow flow)

返回 true if the registered flow is compatible with the passed flow。

返回:

true if the registered flow is compatible with the passed flow

toString

public final String toString()

返回此记录类的字符串表示形式。此表示形式包含类的名称，后跟每个记录组件的名称和值。

指定者:

toString 在类中 Record

返回:

此对象的字符串表示形式

hashCode

public final int hashCode()

返回此对象的哈希代码值。此值派生自每个记录组件的哈希代码。

指定者:

hashCode 在类中 Record

返回:

此对象的哈希代码值

equals

public final boolean equals(Object o)

指示某个其他对象是否“等于”此对象。如果两个对象属于同一个类，而且所有记录组件都相等，则这两个对象相等。 使用 Objects::equals(Object,Object) 对参考组件进行比较；使用 '==' 对基元组件进行比较

指定者:

equals 在类中 Record

参数:

o - 要与之进行比较的对象

返回:

如果此对象与 o 参数相同，则为 true；否则为 false。

type

public CustomPacketPayload.Type<T> type()

返回 type 记录组件的值。

返回:

type 记录组件的值

codec

public StreamCodec<? super RegistryFriendlyByteBuf,T> codec()

返回 codec 记录组件的值。

返回:

codec 记录组件的值

protocols

public List<ConnectionProtocol> protocols()

返回 protocols 记录组件的值。

返回:

protocols 记录组件的值

flow

public Optional<PacketFlow> flow()

返回 flow 记录组件的值。

返回:

flow 记录组件的值

version

public String version()

返回 version 记录组件的值。

返回:

version 记录组件的值

optional

public boolean optional()

返回 optional 记录组件的值。

返回:

optional 记录组件的值