Package io.github.thecsdev.tcdcommons.api.network

Class CustomPayloadNetwork

java.lang.Object

io.github.thecsdev.tcdcommons.api.network.CustomPayloadNetwork

public final class CustomPayloadNetwork
extends Object

This is a utility class that allows you to register custom payload receivers using TCDCommons's network implementation.

See Also:

• registerReceiver(NetworkSide, Identifier, CustomPayloadNetworkReceiver)
• unregisterReceiver(NetworkSide, Identifier)

Field Summary

Fields

Modifier and Type	Field	Description
static final net.minecraft.util.Identifier	CPN_PACKET_ID	The unique Identifier of TCDCommons's TCustomPayload packets for the CustomPayloadNetwork.

Method Summary

Modifier and Type	Method	Description
static CustomPayloadNetworkReceiver	registerPlayReceiver(net.minecraft.network.NetworkSide side, net.minecraft.util.Identifier packetId, CustomPayloadNetworkReceiver receiver)	Registers a CustomPayloadNetworkReceiver for a given custom payload packet.
static CustomPayloadNetworkReceiver	registerReceiver(net.minecraft.network.NetworkSide side, net.minecraft.util.Identifier packetId, CustomPayloadNetworkReceiver receiver)	Deprecated, for removal: This API element is subject to removal in a future version.
static final void	sendC2S(net.minecraft.util.Identifier packetId, io.netty.buffer.ByteBuf packetData)	Sends a custom payload from the client to the server, using the TCDCommons network protocol.
static final void	sendS2C(net.minecraft.server.network.ServerPlayerEntity player, net.minecraft.util.Identifier packetId, io.netty.buffer.ByteBuf packetData)	Sends a custom payload from the server to the client, using the TCDCommons network protocol.
static boolean	unregisterPlayReceiver(net.minecraft.network.NetworkSide side, net.minecraft.util.Identifier packetId)	Un-Registers a CustomPayloadNetworkReceiver for a given custom payload packet.
static boolean	unregisterReceiver(net.minecraft.network.NetworkSide side, net.minecraft.util.Identifier packetId)	Deprecated, for removal: This API element is subject to removal in a future version.

Methods inherited from class java.lang.Object

clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

Field Details

CPN_PACKET_ID

public static final net.minecraft.util.Identifier CPN_PACKET_ID

The unique Identifier of TCDCommons's TCustomPayload packets for the CustomPayloadNetwork.

See Also:

• TCustomPayload.ID

Method Details

registerReceiver

@Deprecated(since="v3.11",
            forRemoval=true)
public static CustomPayloadNetworkReceiver registerReceiver(net.minecraft.network.NetworkSide side,
 net.minecraft.util.Identifier packetId,
 CustomPayloadNetworkReceiver receiver)

Deprecated, for removal: This API element is subject to removal in a future version.

Please use registerPlayReceiver(NetworkSide, Identifier, CustomPayloadNetworkReceiver).
Deprecated because the method's name changed for clarity reasons.

registerPlayReceiver

public static CustomPayloadNetworkReceiver registerPlayReceiver(net.minecraft.network.NetworkSide side,
 net.minecraft.util.Identifier packetId,
 CustomPayloadNetworkReceiver receiver)

Registers a CustomPayloadNetworkReceiver for a given custom payload packet.

Important: Receivers are executed on the network thread.

Parameters:

side - The NetworkSide which to listen on.

packetId - The unique Identifier of the custom payload packets to listen for.

receiver - The listener interface.

Returns:

The CustomPayloadNetworkReceiver that was registered.

Throws:

NullPointerException - If an argument is null.

IllegalArgumentException - If the NetworkSide is "unexpected".

See Also:

• ThreadExecutor.executeSync(Runnable)

unregisterReceiver

@Deprecated(since="v3.11",
            forRemoval=true)
public static boolean unregisterReceiver(net.minecraft.network.NetworkSide side,
 net.minecraft.util.Identifier packetId)

Deprecated, for removal: This API element is subject to removal in a future version.

Please see unregisterPlayReceiver(NetworkSide, Identifier).
Deprecated because the method's name changed for clarity reasons.

unregisterPlayReceiver

public static boolean unregisterPlayReceiver(net.minecraft.network.NetworkSide side,
 net.minecraft.util.Identifier packetId)

Un-Registers a CustomPayloadNetworkReceiver for a given custom payload packet.

Parameters:

side - The NetworkSide the CustomPayloadNetworkReceiver is listening on.

packetId - The unique Identifier of the custom payload packets being listened.

Returns:

true if the CustomPayloadNetworkReceiver was present before getting removed.

sendC2S

public static final void sendC2S(net.minecraft.util.Identifier packetId,
 io.netty.buffer.ByteBuf packetData)
                          throws IllegalStateException,
NullPointerException

Sends a custom payload from the client to the server, using the TCDCommons network protocol.

Parameters:

packetId - The custom payload packet Identifier.

packetData - The custom payload.

Throws:

NullPointerException - If an argument is null.

IllegalStateException - If (NOT_CLIENT) or (REF_CNT < 1).

sendS2C

public static final void sendS2C(net.minecraft.server.network.ServerPlayerEntity player,
 net.minecraft.util.Identifier packetId,
 io.netty.buffer.ByteBuf packetData)
                          throws IllegalStateException,
NullPointerException

Sends a custom payload from the server to the client, using the TCDCommons network protocol.

Parameters:

player - The ServerPlayerEntity to send the packet to.

packetId - The custom payload packet Identifier.

packetData - The custom payload.

Throws:

NullPointerException - If an argument is null.

IllegalStateException - If (REF_CNT < 1).