net.fabricmc.fabric.api.network

Interface ClientSidePacketRegistry

All Superinterfaces:

PacketRegistry

public interface ClientSidePacketRegistry
extends PacketRegistry

The client-side packet registry.

It is used for:

• registering client-side packet receivers (server -> client packets)
• sending packets to the server (client -> server packets).

Field Summary

Fields

Modifier and Type	Field and Description
static ClientSidePacketRegistry	INSTANCE

Method Summary

Modifier and Type	Method and Description
boolean	canServerReceive(net.minecraft.util.Identifier id) Check if the server declared the ability to receive a given packet ID using the vanilla "register/unregister" protocol.
default void	sendToServer(net.minecraft.util.Identifier id, net.minecraft.network.PacketByteBuf buf) Send an identifier/buffer-based packet to the server.
default void	sendToServer(net.minecraft.util.Identifier id, net.minecraft.network.PacketByteBuf buf, io.netty.util.concurrent.GenericFutureListener<? extends io.netty.util.concurrent.Future<? super Void>> completionListener) Send an identifier/buffer-based packet to the server.
default void	sendToServer(net.minecraft.network.Packet<?> packet) Send a packet to the server.
void	sendToServer(net.minecraft.network.Packet<?> packet, io.netty.util.concurrent.GenericFutureListener<? extends io.netty.util.concurrent.Future<? super Void>> completionListener) Send a packet to the server.

Methods inherited from interface net.fabricmc.fabric.api.network.PacketRegistry

register, toPacket, unregister

Field Detail

INSTANCE

static final ClientSidePacketRegistry INSTANCE

Method Detail

canServerReceive

boolean canServerReceive(net.minecraft.util.Identifier id)

Check if the server declared the ability to receive a given packet ID using the vanilla "register/unregister" protocol.

Parameters:

id - The packet identifier.

Returns:

True if the server side declared a given packet identifier.

sendToServer

void sendToServer(net.minecraft.network.Packet<?> packet,
                  io.netty.util.concurrent.GenericFutureListener<? extends io.netty.util.concurrent.Future<? super Void>> completionListener)

Send a packet to the server.

Parameters:

packet - The packet to be sent.

completionListener - Completion listener. Can be used to check for the success or failure of sending a given packet, among others.

sendToServer

default void sendToServer(net.minecraft.util.Identifier id,
                          net.minecraft.network.PacketByteBuf buf,
                          io.netty.util.concurrent.GenericFutureListener<? extends io.netty.util.concurrent.Future<? super Void>> completionListener)

Send an identifier/buffer-based packet to the server.

Parameters:

id - The packet identifier.

buf - The packet byte buffer.

completionListener - Completion listener. Can be used to check for the success or failure of sending a given packet, among others.

sendToServer

default void sendToServer(net.minecraft.network.Packet<?> packet)

Send a packet to the server.

Parameters:

packet - The packet to be sent.

sendToServer

default void sendToServer(net.minecraft.util.Identifier id,
                          net.minecraft.network.PacketByteBuf buf)

Send an identifier/buffer-based packet to the server.

Parameters:

id - The packet identifier.

buf - The packet byte buffer.