Class PacketRegistrationHandler

java.lang.Object

commonnetwork.networking.PacketRegistrationHandler

All Implemented Interfaces:

NetworkHandler, PacketRegistrar

public abstract class PacketRegistrationHandler
extends Object
implements NetworkHandler, PacketRegistrar

Field Summary

Fields

Modifier and Type	Field	Description
protected final Side	side

Constructor Summary

Constructors

Constructor	Description
PacketRegistrationHandler(Side side)

Method Summary

Modifier and Type	Method	Description
protected @Nullable PacketContainer<?>	getPacketContainer(net.minecraft.resources.Identifier id)
<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
Side	getSide()
protected abstract <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> PacketRegistrar	registerConfigurationPacket(net.minecraft.network.protocol.common.custom.CustomPacketPayload.Type<T> type, net.minecraft.network.codec.StreamCodec<? extends net.minecraft.network.FriendlyByteBuf, T> codec, Consumer<PacketContext<T>> handler)	Packet Registration, registers a CONFIGURATION packet
<T extends net.minecraft.network.protocol.common.custom.CustomPacketPayload> PacketRegistrar	registerPacket(net.minecraft.network.protocol.common.custom.CustomPacketPayload.Type<T> type, net.minecraft.network.codec.StreamCodec<? extends net.minecraft.network.FriendlyByteBuf, T> codec, Consumer<PacketContext<T>> handler)	Packet Registration, registers a PLAY packet
protected <T extends net.minecraft.network.protocol.common.custom.CustomPacketPayload> PacketContainer<T>	requireContainer(T packet)	Looks up the registered PacketContainer for the given packet, throwing if it is not registered.
protected boolean	supports(PacketContainer.PacketType type)

Methods inherited from class Object

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

Methods inherited from interface NetworkHandler

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

Field Details

side

protected final Side side

Constructor Details

PacketRegistrationHandler

public PacketRegistrationHandler(Side side)

Method Details

registerPacket

public <T extends net.minecraft.network.protocol.common.custom.CustomPacketPayload>
PacketRegistrar registerPacket(net.minecraft.network.protocol.common.custom.CustomPacketPayload.Type<T> type,
 net.minecraft.network.codec.StreamCodec<? extends net.minecraft.network.FriendlyByteBuf, T> codec,
 Consumer<PacketContext<T>> handler)

Description copied from interface: PacketRegistrar

Packet Registration, registers a PLAY packet

Specified by:

registerPacket in interface PacketRegistrar

Type Parameters:

T - - The packet type

Parameters:

type - - The packet type.

codec - - The StreamCodec.

handler - - The handler method.

Returns:

The registrar for chaining registrations.

registerConfigurationPacket

public <T extends net.minecraft.network.protocol.common.custom.CustomPacketPayload>
PacketRegistrar registerConfigurationPacket(net.minecraft.network.protocol.common.custom.CustomPacketPayload.Type<T> type,
 net.minecraft.network.codec.StreamCodec<? extends net.minecraft.network.FriendlyByteBuf, T> codec,
 Consumer<PacketContext<T>> handler)

Description copied from interface: PacketRegistrar

Packet Registration, registers a CONFIGURATION packet

Specified by:

registerConfigurationPacket in interface PacketRegistrar

Type Parameters:

T - - The packet type

Parameters:

type - - The packet type.

codec - - The StreamCodec.

handler - - The handler method.

Returns:

The registrar for chaining registrations.

supports

protected boolean supports(PacketContainer.PacketType type)

getPacketContainer

@Nullable
protected @Nullable PacketContainer<?> getPacketContainer(net.minecraft.resources.Identifier id)

getSide

public Side getSide()

Specified by:

getSide in interface PacketRegistrar

Returns:

the side

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

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

Type Parameters:

T - - The packet type

Parameters:

packet - - the packet

Returns:

The packet wrapped into a ServerboundCustomPayloadPacket

requireContainer

protected <T extends net.minecraft.network.protocol.common.custom.CustomPacketPayload>
PacketContainer<T> requireContainer(T packet)

Looks up the registered PacketContainer for the given packet, throwing if it is not registered.

onRegister

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

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