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

记录类 ServerPayloadContext

java.lang.Object

java.lang.Record

net.neoforged.neoforge.network.handling.ServerPayloadContext

所有已实现的接口:

IPayloadContext

@Internal
public record ServerPayloadContext(ServerCommonPacketListener listener, ResourceLocation payloadId)
extends Record
implements IPayloadContext

字段概要

字段

修饰符和类型	字段	说明
private final ServerCommonPacketListener	listener	listener 记录组件的字段。
private final ResourceLocation	payloadId	payloadId 记录组件的字段。

构造器概要

构造器

构造器	说明
ServerPayloadContext(ServerCommonPacketListener listener, ResourceLocation payloadId)	创建 ServerPayloadContext 记录类的实例。

方法概要

修饰符和类型	方法	说明
CompletableFuture<Void>	enqueueWork(Runnable task)	For handlers running on the network thread, submits the given task to be run on the main thread of the game.
<T> CompletableFuture<T>	enqueueWork(Supplier<T> task)
final boolean	equals(Object o)	指示某个其他对象是否“等于”此对象。
void	finishCurrentTask(ConfigurationTask.Type type)	Marks a ConfigurationTask as completed.
PacketFlow	flow()	返回 the flow of the received payload。
void	handle(CustomPacketPayload payload)	Handles a payload using the current context.
final int	hashCode()	返回此对象的哈希代码值。
ServerCommonPacketListener	listener()	返回 listener 记录组件的值。
ResourceLocation	payloadId()	返回 payloadId 记录组件的值。
ServerPlayer	player()	Retrieves the player relevant to this payload.
final String	toString()	返回此记录类的字符串表示形式。

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

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

从接口继承的方法 net.neoforged.neoforge.network.handling.IPayloadContext

channelHandlerContext, connection, disconnect, handle, protocol, reply

字段详细资料

listener

private final ServerCommonPacketListener listener

listener 记录组件的字段。

payloadId

private final ResourceLocation payloadId

payloadId 记录组件的字段。

构造器详细资料

ServerPayloadContext

public ServerPayloadContext(ServerCommonPacketListener listener,
 ResourceLocation payloadId)

创建 ServerPayloadContext 记录类的实例。

参数:

listener - listener 记录组件的值

payloadId - payloadId 记录组件的值

方法详细资料

handle

public void handle(CustomPacketPayload payload)

从接口复制的说明: IPayloadContext

Handles a payload using the current context.

Used to handle sub-payloads if necessary.

指定者:

handle 在接口中 IPayloadContext

参数:

payload - The payload.

enqueueWork

public CompletableFuture<Void> enqueueWork(Runnable task)

从接口复制的说明: IPayloadContext

For handlers running on the network thread, submits the given task to be run on the main thread of the game.

For handlers running on the main thread, immediately executes the task.

On the network thread, the future will be automatically guarded against exceptions using CompletableFuture.exceptionally(java.util.function.Function<java.lang.Throwable, ? extends T>). If you need to catch your own exceptions, use a try/catch block within your task.

指定者:

enqueueWork 在接口中 IPayloadContext

参数:

task - The task to run.

enqueueWork

public <T> CompletableFuture<T> enqueueWork(Supplier<T> task)

指定者:

enqueueWork 在接口中 IPayloadContext

另请参阅:

• IPayloadContext.enqueueWork(Runnable)

finishCurrentTask

public void finishCurrentTask(ConfigurationTask.Type type)

从接口复制的说明: IPayloadContext

Marks a ConfigurationTask as completed.

指定者:

finishCurrentTask 在接口中 IPayloadContext

参数:

type - The type of task that was completed.

flow

public PacketFlow flow()

从接口复制的说明: IPayloadContext

返回 the flow of the received payload。

指定者:

flow 在接口中 IPayloadContext

返回:

the flow of the received payload

player

public ServerPlayer player()

从接口复制的说明: IPayloadContext

Retrieves the player relevant to this payload. Players are only available in the ConnectionProtocol.PLAY phase.

For server-bound payloads, retrieves the sending ServerPlayer.

For client-bound payloads, retrieves the receiving LocalPlayer.

指定者:

player 在接口中 IPayloadContext

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。

listener

public ServerCommonPacketListener listener()

返回 listener 记录组件的值。

指定者:

listener 在接口中 IPayloadContext

返回:

listener 记录组件的值

payloadId

public ResourceLocation payloadId()

返回 payloadId 记录组件的值。

返回:

payloadId 记录组件的值