Class PaperNetworkHandler

java.lang.Object

commonnetwork.networking.PacketRegistrationHandler

commonnetwork.networking.PaperNetworkHandler

All Implemented Interfaces:

NetworkHandler, PacketRegistrar, org.bukkit.plugin.messaging.PluginMessageListener

public class PaperNetworkHandler
extends PacketRegistrationHandler
implements org.bukkit.plugin.messaging.PluginMessageListener

Field Summary

Fields inherited from class PacketRegistrationHandler

side

Constructor Summary

Constructors

Constructor	Description
PaperNetworkHandler(org.bukkit.plugin.java.JavaPlugin plugin, Side side)

Method Summary

Modifier and Type	Method	Description
<T extends net.minecraft.network.protocol.common.custom.CustomPacketPayload> @Nullable net.minecraft.network.protocol.common.ClientboundCustomPayloadPacket	getRawClientboundPacket(T packet)	Generates a ClientboundCustomPayloadPacket
<T extends net.minecraft.network.protocol.common.custom.CustomPacketPayload> @Nullable net.minecraft.network.protocol.common.ServerboundCustomPayloadPacket	getRawServerboundPacket(T packet)	Generates a ServerboundCustomPayloadPacket
void	onPluginMessageReceived(String channel, org.bukkit.entity.Player player, byte[] message)
protected <T extends net.minecraft.network.protocol.common.custom.CustomPacketPayload> void	onRegister(PacketContainer<T> container)	Loader-specific wiring for a freshly-registered packet.
<T extends net.minecraft.network.protocol.common.custom.CustomPacketPayload> void	send(T packet, net.minecraft.network.Connection connection)	Sends the packet to the connection.
<T extends net.minecraft.network.protocol.common.custom.CustomPacketPayload> void	sendToClient(T packet, net.minecraft.server.level.ServerPlayer player, boolean ignoreCheck)	Sends the packet to the client player.
<T extends net.minecraft.network.protocol.common.custom.CustomPacketPayload> void	sendToServer(T packet, boolean ignoreCheck)	Sends the packet to the server.
void	shutdown()
protected boolean	supports(PacketContainer.PacketType type)

Methods inherited from class PacketRegistrationHandler

getPacketContainer, getSide, registerConfigurationPacket, registerPacket, requireContainer

Methods inherited from class Object

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

Methods inherited from interface NetworkHandler

sendToAllClients, sendToAllClients, sendToClient, sendToClients, sendToClients, sendToClientsInLevel, sendToClientsInLevel, sendToClientsInRange, sendToClientsInRange, sendToClientsLoadingChunk, sendToClientsLoadingChunk, sendToClientsLoadingPos, sendToClientsLoadingPos, sendToClientsLoadingPos, sendToClientsLoadingPos, sendToServer

Methods inherited from interface org.bukkit.plugin.messaging.PluginMessageListener

onPluginMessageReceived

Constructor Details

PaperNetworkHandler

public PaperNetworkHandler(org.bukkit.plugin.java.JavaPlugin plugin,
 Side side)

Method Details

supports

protected boolean supports(PacketContainer.PacketType type)

Overrides:

supports in class PacketRegistrationHandler

onRegister

protected <T extends net.minecraft.network.protocol.common.custom.CustomPacketPayload>
void onRegister(PacketContainer<T> container)

Description copied from class: PacketRegistrationHandler

Loader-specific wiring for a freshly-registered packet. May be a no-op if the loader defers registration to its own lifecycle event.

Specified by:

onRegister in class PacketRegistrationHandler

shutdown

public void shutdown()

onPluginMessageReceived

public void onPluginMessageReceived(String channel,
 org.bukkit.entity.Player player,
 byte[] message)

Specified by:

onPluginMessageReceived in interface org.bukkit.plugin.messaging.PluginMessageListener

sendToClient

public <T extends net.minecraft.network.protocol.common.custom.CustomPacketPayload>
void sendToClient(T packet,
 net.minecraft.server.level.ServerPlayer player,
 boolean ignoreCheck)

Description copied from interface: NetworkHandler

Sends the packet to the client player.

Specified by:

sendToClient in interface NetworkHandler

Type Parameters:

T - - The packet type

Parameters:

packet - - the packet

player - - the player

ignoreCheck - - ignore the check if the client has the packet registered.

sendToServer

public <T extends net.minecraft.network.protocol.common.custom.CustomPacketPayload>
void sendToServer(T packet,
 boolean ignoreCheck)

Description copied from interface: NetworkHandler

Sends the packet to the server. Can ignore the check if the server has the packet registered. Likely use case for this is talking to bukkit/spigot/paper servers.

Specified by:

sendToServer in interface NetworkHandler

Type Parameters:

T - - The packet type

Parameters:

packet - - the packet

ignoreCheck - - ignore the check if the server has the packet registered.

send

public <T extends net.minecraft.network.protocol.common.custom.CustomPacketPayload>
void send(T packet,
 net.minecraft.network.Connection connection)

Description copied from interface: NetworkHandler

Sends the packet to the connection.

Specified by:

send in interface NetworkHandler

Type Parameters:

T - - The packet type

Parameters:

packet - - the packet

connection - - the connection

getRawClientboundPacket

@Nullable
public <T extends net.minecraft.network.protocol.common.custom.CustomPacketPayload>
@Nullable net.minecraft.network.protocol.common.ClientboundCustomPayloadPacket getRawClientboundPacket(T packet)

Description copied from interface: NetworkHandler

Generates a ClientboundCustomPayloadPacket

Specified by:

getRawClientboundPacket in interface NetworkHandler

Overrides:

getRawClientboundPacket in class PacketRegistrationHandler

Type Parameters:

T - - The packet type

Parameters:

packet - - the packet

Returns:

The packet wrapped into a ClientboundCustomPayloadPacket

getRawServerboundPacket

@Nullable
public <T extends net.minecraft.network.protocol.common.custom.CustomPacketPayload>
@Nullable net.minecraft.network.protocol.common.ServerboundCustomPayloadPacket getRawServerboundPacket(T packet)

Description copied from interface: NetworkHandler

Generates a ServerboundCustomPayloadPacket

Specified by:

getRawServerboundPacket in interface NetworkHandler

Overrides:

getRawServerboundPacket in class PacketRegistrationHandler

Type Parameters:

T - - The packet type

Parameters:

packet - - the packet

Returns:

The packet wrapped into a ServerboundCustomPayloadPacket