Uses of Interface
net.minecraft.network.protocol.common.custom.CustomPacketPayload

Packages that use CustomPacketPayload

Package	Description
net.minecraft.client.multiplayer
net.minecraft.network.protocol.common
net.minecraft.network.protocol.common.custom
net.minecraft.network.protocol.game
net.neoforged.neoforge.client.network
net.neoforged.neoforge.client.network.event
net.neoforged.neoforge.client.network.handling
net.neoforged.neoforge.client.network.registration
net.neoforged.neoforge.common.extensions
net.neoforged.neoforge.network
net.neoforged.neoforge.network.configuration
net.neoforged.neoforge.network.handling
net.neoforged.neoforge.network.payload
net.neoforged.neoforge.network.registration

Uses of CustomPacketPayload in net.minecraft.client.multiplayer

Methods in net.minecraft.client.multiplayer with parameters of type CustomPacketPayload

Modifier and Type	Method	Description
protected abstract void	ClientCommonPacketListenerImpl.handleCustomPayload(CustomPacketPayload pPayload)
protected void	ClientConfigurationPacketListenerImpl.handleCustomPayload(CustomPacketPayload pPayload)
void	ClientPacketListener.handleCustomPayload(CustomPacketPayload pPayload)
private void	ClientConfigurationPacketListenerImpl.handleUnknownCustomPayload(CustomPacketPayload pPayload)
private void	ClientPacketListener.handleUnknownCustomPayload(CustomPacketPayload pPacket)

Uses of CustomPacketPayload in net.minecraft.network.protocol.common

Fields in net.minecraft.network.protocol.common declared as CustomPacketPayload

Modifier and Type	Field	Description
private final CustomPacketPayload	ClientboundCustomPayloadPacket.payload	The field for the payload record component.
private final CustomPacketPayload	ServerboundCustomPayloadPacket.payload	The field for the payload record component.

Methods in net.minecraft.network.protocol.common that return CustomPacketPayload

Modifier and Type	Method	Description
CustomPacketPayload	ClientboundCustomPayloadPacket.payload()	Returns the value of the payload record component.
CustomPacketPayload	ServerboundCustomPayloadPacket.payload()	Returns the value of the payload record component.

Constructors in net.minecraft.network.protocol.common with parameters of type CustomPacketPayload

Modifier	Constructor	Description
	ClientboundCustomPayloadPacket(CustomPacketPayload payload)	Creates an instance of a ClientboundCustomPayloadPacket record class.
	ServerboundCustomPayloadPacket(CustomPacketPayload payload)	Creates an instance of a ServerboundCustomPayloadPacket record class.

Uses of CustomPacketPayload in net.minecraft.network.protocol.common.custom

Classes in net.minecraft.network.protocol.common.custom with type parameters of type CustomPacketPayload

Modifier and Type	Class	Description
static final record	CustomPacketPayload.Type<T extends CustomPacketPayload>
static final record	CustomPacketPayload.TypeAndCodec<B extends FriendlyByteBuf,T extends CustomPacketPayload>

Classes in net.minecraft.network.protocol.common.custom that implement CustomPacketPayload

Modifier and Type	Class	Description
final record	BeeDebugPayload
final record	BrainDebugPayload
final record	BrandPayload
final record	BreezeDebugPayload
final record	DiscardedPayload
final record	GameEventDebugPayload
final record	GameEventListenerDebugPayload
final record	GameTestAddMarkerDebugPayload
final record	GameTestClearMarkersDebugPayload
final record	GoalDebugPayload
final record	HiveDebugPayload
final record	NeighborUpdatesDebugPayload
final record	PathfindingDebugPayload
final record	PoiAddedDebugPayload
final record	PoiRemovedDebugPayload
final record	PoiTicketCountDebugPayload
final record	RaidsDebugPayload
final record	RedstoneWireOrientationsDebugPayload
final record	StructuresDebugPayload
final record	VillageSectionsDebugPayload
final record	WorldGenAttemptDebugPayload

Methods in net.minecraft.network.protocol.common.custom with type parameters of type CustomPacketPayload

Modifier and Type	Method	Description
static <B extends io.netty.buffer.ByteBuf, T extends CustomPacketPayload> StreamCodec<B,T>	CustomPacketPayload.codec(StreamMemberEncoder<B,T> pEncoder, StreamDecoder<B,T> pDecoder)
static <T extends CustomPacketPayload> CustomPacketPayload.Type<T>	CustomPacketPayload.createType(String pId)

Methods in net.minecraft.network.protocol.common.custom that return types with arguments of type CustomPacketPayload

Modifier and Type	Method	Description
static <B extends FriendlyByteBuf> StreamCodec<B,CustomPacketPayload>	CustomPacketPayload.codec(CustomPacketPayload.FallbackProvider<B> pFallbackProvider, List<CustomPacketPayload.TypeAndCodec<? super B,?>> pTypeAndCodecs, ConnectionProtocol protocol, PacketFlow packetFlow)
StreamCodec<B,? extends CustomPacketPayload>	CustomPacketPayload.FallbackProvider.create(ResourceLocation pId)
CustomPacketPayload.Type<? extends CustomPacketPayload>	CustomPacketPayload.type()

Uses of CustomPacketPayload in net.minecraft.network.protocol.game

Methods in net.minecraft.network.protocol.game with parameters of type CustomPacketPayload

Modifier and Type	Method	Description
private static void	DebugPackets.sendPacketToAllPlayers(ServerLevel pLevel, CustomPacketPayload pPayload)

Uses of CustomPacketPayload in net.neoforged.neoforge.client.network

Methods in net.neoforged.neoforge.client.network with parameters of type CustomPacketPayload

Modifier and Type	Method	Description
static void	ClientPacketDistributor.sendToServer(CustomPacketPayload payload, CustomPacketPayload... payloads)	Send the given payload(s) to the server

Uses of CustomPacketPayload in net.neoforged.neoforge.client.network.event

Methods in net.neoforged.neoforge.client.network.event with type parameters of type CustomPacketPayload

Modifier and Type	Method	Description
<T extends CustomPacketPayload> void	RegisterClientPayloadHandlersEvent.register(CustomPacketPayload.Type<T> type, IPayloadHandler<T> handler)	Registers the provided IPayloadHandler as the client handler to be invoked on the main thread for the provided CustomPacketPayload.Type
<T extends CustomPacketPayload> void	RegisterClientPayloadHandlersEvent.register(CustomPacketPayload.Type<T> type, HandlerThread thread, IPayloadHandler<T> handler)	Registers the provided IPayloadHandler as the client handler to be invoked on the specified thread for the provided CustomPacketPayload.Type

Uses of CustomPacketPayload in net.neoforged.neoforge.client.network.handling

Methods in net.neoforged.neoforge.client.network.handling with parameters of type CustomPacketPayload

Modifier and Type	Method	Description
void	ClientPayloadContext.handle(CustomPacketPayload payload)

Uses of CustomPacketPayload in net.neoforged.neoforge.client.network.registration

Methods in net.neoforged.neoforge.client.network.registration with type parameters of type CustomPacketPayload

Modifier and Type	Method	Description
static <T extends CustomPacketPayload> void	ClientNetworkRegistry.register(CustomPacketPayload.Type<T> type, HandlerThread thread, IPayloadHandler<T> handler)

Uses of CustomPacketPayload in net.neoforged.neoforge.common.extensions

Methods in net.neoforged.neoforge.common.extensions with parameters of type CustomPacketPayload

Modifier and Type	Method	Description
default void	IPlayerListExtension.broadcast(double x, double y, double z, double range, ResourceKey<Level> level, CustomPacketPayload payload)	Sends a payload to all players within the specific level, within a given range around the target point
default void	IPlayerListExtension.broadcast(Player excludedPlayer, double x, double y, double z, double range, ResourceKey<Level> level, CustomPacketPayload payload)	Sends a payload to all players within the specific level, within a given range around the target point, excluding the specified player.
default void	IServerChunkCacheExtension.broadcast(Entity entity, CustomPacketPayload payload)	Sends a payload to all players watching the given entity.
default void	IPlayerListExtension.broadcastAll(CustomPacketPayload payload)	Sends a payload to all players on the server
default void	IPlayerListExtension.broadcastAll(CustomPacketPayload payload, ResourceKey<Level> targetLevel)	Sends a payload to all players within the specific level.
default void	IServerChunkCacheExtension.broadcastAndSend(Entity entity, CustomPacketPayload payload)	Sends a payload to all players watching the given entity.
default boolean	ICommonPacketListener.hasChannel(CustomPacketPayload payload)
default void	IClientCommonPacketListenerExtension.send(CustomPacketPayload payload)	Sends a payload to the target of this listener.
void	ICommonPacketListener.send(CustomPacketPayload payload)	Sends a payload to the target of this listener.
default void	IServerCommonPacketListenerExtension.send(CustomPacketPayload payload)	Sends a payload to the target of this listener.
default void	IServerCommonPacketListenerExtension.send(CustomPacketPayload payload, @Nullable io.netty.channel.ChannelFutureListener listener)	Sends a payload to the client of this listener.
default void	IServerGamePacketListenerExtension.sendBundled(CustomPacketPayload... payloads)	Sends all given payloads as a bundle to the client.

Method parameters in net.neoforged.neoforge.common.extensions with type arguments of type CustomPacketPayload

Modifier and Type	Method	Description
default void	IServerGamePacketListenerExtension.sendBundled(Iterable<CustomPacketPayload> payloads)	Sends all given payloads as a bundle to the client.
default void	IEntityExtension.sendPairingData(ServerPlayer serverPlayer, Consumer<CustomPacketPayload> bundleBuilder)	Sends the pairing data to the client.

Uses of CustomPacketPayload in net.neoforged.neoforge.network

Methods in net.neoforged.neoforge.network with parameters of type CustomPacketPayload

Modifier and Type	Method	Description
private static Packet<?>	PacketDistributor.makeClientboundPacket(CustomPacketPayload payload, CustomPacketPayload... payloads)
static void	PacketDistributor.sendToAllPlayers(CustomPacketPayload payload, CustomPacketPayload... payloads)	Send the given payload(s) to all players on the server
static void	PacketDistributor.sendToPlayer(ServerPlayer player, CustomPacketPayload payload, CustomPacketPayload... payloads)	Send the given payload(s) to the given player
static void	PacketDistributor.sendToPlayersInDimension(ServerLevel level, CustomPacketPayload payload, CustomPacketPayload... payloads)	Send the given payload(s) to all players in the given dimension
static void	PacketDistributor.sendToPlayersNear(ServerLevel level, @Nullable ServerPlayer excluded, double x, double y, double z, double radius, CustomPacketPayload payload, CustomPacketPayload... payloads)	Send the given payload(s) to all players in the area covered by the given radius around the given coordinates in the given dimension, except the given excluded player if present
static void	PacketDistributor.sendToPlayersTrackingChunk(ServerLevel level, ChunkPos chunkPos, CustomPacketPayload payload, CustomPacketPayload... payloads)	Send the given payload(s) to all players tracking the chunk at the given position in the given level
static void	PacketDistributor.sendToPlayersTrackingEntity(Entity entity, CustomPacketPayload payload, CustomPacketPayload... payloads)	Send the given payload(s) to all players tracking the given entity
static void	PacketDistributor.sendToPlayersTrackingEntityAndSelf(Entity entity, CustomPacketPayload payload, CustomPacketPayload... payloads)	Send the given payload(s) to all players tracking the given entity and the entity itself if it is a player

Uses of CustomPacketPayload in net.neoforged.neoforge.network.configuration

Method parameters in net.neoforged.neoforge.network.configuration with type arguments of type CustomPacketPayload

Modifier and Type	Method	Description
void	CommonRegisterTask.run(Consumer<CustomPacketPayload> sender)
void	CommonVersionTask.run(Consumer<CustomPacketPayload> sender)
void	ICustomConfigurationTask.run(Consumer<CustomPacketPayload> sender)	Invoked when it is time for this configuration to run.
void	RegistryDataMapNegotiation.run(Consumer<CustomPacketPayload> sender)
void	SyncConfig.run(Consumer<CustomPacketPayload> sender)
void	SyncRegistries.run(Consumer<CustomPacketPayload> sender)

Uses of CustomPacketPayload in net.neoforged.neoforge.network.handling

Classes in net.neoforged.neoforge.network.handling with type parameters of type CustomPacketPayload

Modifier and Type	Interface	Description
interface	IPayloadHandler<T extends CustomPacketPayload>	Callback for handling custom packets.
final record	MainThreadPayloadHandler<T extends CustomPacketPayload>	Helper class that always executes the wrapped handler on the main thread.

Methods in net.neoforged.neoforge.network.handling with parameters of type CustomPacketPayload

Modifier and Type	Method	Description
void	IPayloadContext.handle(CustomPacketPayload payload)	Handles a payload using the current context.
void	ServerPayloadContext.handle(CustomPacketPayload payload)
default void	IPayloadContext.reply(CustomPacketPayload payload)	Sends the given payload back to the sender.

Uses of CustomPacketPayload in net.neoforged.neoforge.network.payload

Classes in net.neoforged.neoforge.network.payload that implement CustomPacketPayload

Modifier and Type	Class	Description
final record	AdvancedAddEntityPayload	Payload that can be sent from the server to the client to add an entity to the world, with custom data.
final record	AdvancedContainerSetDataPayload	A custom payload that updates the full dataslot value instead of just the short value
final record	AdvancedOpenScreenPayload	A custom payload that allows for opening screens with additional data.
final record	AuxiliaryLightDataPayload
final record	ClientboundCustomSetTimePayload
final record	CommonRegisterPayload	Common Register, used to send play-phase channels during the configuration phase.
final record	CommonVersionPayload	Common version payload.
final record	ConfigFilePayload	A payload that contains a config file.
final class	ExtensibleEnumAcknowledgePayload
final record	ExtensibleEnumDataPayload
final class	FeatureFlagAcknowledgePayload
final record	FeatureFlagDataPayload
final record	FrozenRegistryPayload	Packet payload for sending a frozen registry to the client
final class	FrozenRegistrySyncCompletedPayload	This payload is sent to the client when the server has finished sending all the frozen registries.
final record	FrozenRegistrySyncStartPayload	Packet payload sent to the client to start the frozen registry sync.
final record	KnownRegistryDataMapsPayload
final record	KnownRegistryDataMapsReplyPayload
final record	MinecraftRegisterPayload
final record	MinecraftUnregisterPayload
final record	ModdedNetworkPayload	A payload that contains the modded network configuration and play components.
final record	ModdedNetworkQueryPayload	Payload for the modded network query request.
final record	ModdedNetworkSetupFailedPayload	Payload sent to the client when the server has failed to set up the modded network.
final record	RecipeContentPayload	We use this to transfer the actual recipe content from server to client.
final record	RegistryDataMapSyncPayload<T>
final record	SplitPacketPayload	A payload that is used to split a packet into multiple payloads.
final record	SyncAttachmentsPayload

Methods in net.neoforged.neoforge.network.payload that return types with arguments of type CustomPacketPayload

Modifier and Type	Method	Description
CustomPacketPayload.Type<? extends CustomPacketPayload>	SyncAttachmentsPayload.type()

Uses of CustomPacketPayload in net.neoforged.neoforge.network.registration

Classes in net.neoforged.neoforge.network.registration with type parameters of type CustomPacketPayload

Modifier and Type	Class	Description
final record	ModdedConfigurationPayloadRegistration<T extends CustomPacketPayload>	Registration for a custom packet payload.
final record	ModdedPlayPayloadRegistration<T extends CustomPacketPayload>	Registration for a custom packet payload.
final record	PayloadRegistration<T extends CustomPacketPayload>	Holds the information needed to describe a registered payload.

Fields in net.neoforged.neoforge.network.registration with type parameters of type CustomPacketPayload

Modifier and Type	Field	Description
protected static final Map<ResourceLocation,StreamCodec<FriendlyByteBuf,? extends CustomPacketPayload>>	NetworkRegistry.BUILTIN_PAYLOADS	Map of NeoForge payloads that may be sent before channel negotiation.

Methods in net.neoforged.neoforge.network.registration with type parameters of type CustomPacketPayload

Modifier and Type	Method	Description
<T extends CustomPacketPayload> PayloadRegistrar	PayloadRegistrar.commonBidirectional(CustomPacketPayload.Type<T> type, StreamCodec<? super FriendlyByteBuf,T> codec, IPayloadHandler<T> serverHandler)	Registers a bidirectional payload for all phases.
<T extends CustomPacketPayload> PayloadRegistrar	PayloadRegistrar.commonBidirectional(CustomPacketPayload.Type<T> type, StreamCodec<? super FriendlyByteBuf,T> codec, IPayloadHandler<T> serverHandler, @Nullable IPayloadHandler<T> clientHandler)	Registers a bidirectional payload for all phases.
<T extends CustomPacketPayload> PayloadRegistrar	PayloadRegistrar.commonToClient(CustomPacketPayload.Type<T> type, StreamCodec<? super FriendlyByteBuf,T> codec)	Registers a client-bound payload for all phases without a handler.
<T extends CustomPacketPayload> PayloadRegistrar	PayloadRegistrar.commonToClient(CustomPacketPayload.Type<T> type, StreamCodec<? super FriendlyByteBuf,T> codec, IPayloadHandler<T> handler)	Registers a client-bound payload for all phases.
<T extends CustomPacketPayload> PayloadRegistrar	PayloadRegistrar.commonToServer(CustomPacketPayload.Type<T> type, StreamCodec<? super FriendlyByteBuf,T> codec, IPayloadHandler<T> handler)	Registers a server-bound payload for all phases.
<T extends CustomPacketPayload> PayloadRegistrar	PayloadRegistrar.configurationBidirectional(CustomPacketPayload.Type<T> type, StreamCodec<? super FriendlyByteBuf,T> codec, IPayloadHandler<T> serverHandler)	Registers a bidirectional payload for the configuration phase.
<T extends CustomPacketPayload> PayloadRegistrar	PayloadRegistrar.configurationBidirectional(CustomPacketPayload.Type<T> type, StreamCodec<? super FriendlyByteBuf,T> codec, IPayloadHandler<T> serverHandler, @Nullable IPayloadHandler<T> clientHandler)	Registers a bidirectional payload for the configuration phase.
<T extends CustomPacketPayload> PayloadRegistrar	PayloadRegistrar.configurationToClient(CustomPacketPayload.Type<T> type, StreamCodec<? super FriendlyByteBuf,T> codec)	Registers a client-bound payload for the configuration phase without a handler.
<T extends CustomPacketPayload> PayloadRegistrar	PayloadRegistrar.configurationToClient(CustomPacketPayload.Type<T> type, StreamCodec<? super FriendlyByteBuf,T> codec, IPayloadHandler<T> handler)	Registers a client-bound payload for the configuration phase.
<T extends CustomPacketPayload> PayloadRegistrar	PayloadRegistrar.configurationToServer(CustomPacketPayload.Type<T> type, StreamCodec<? super FriendlyByteBuf,T> codec, IPayloadHandler<T> handler)	Registers a server-bound payload for the configuration phase.
<T extends CustomPacketPayload> PayloadRegistrar	PayloadRegistrar.playBidirectional(CustomPacketPayload.Type<T> type, StreamCodec<? super RegistryFriendlyByteBuf,T> codec, IPayloadHandler<T> serverHandler)	Registers a bidirectional payload for the play phase.
<T extends CustomPacketPayload> PayloadRegistrar	PayloadRegistrar.playBidirectional(CustomPacketPayload.Type<T> type, StreamCodec<? super RegistryFriendlyByteBuf,T> codec, IPayloadHandler<T> serverHandler, @Nullable IPayloadHandler<T> clientHandler)	Registers a bidirectional payload for the play phase.
<T extends CustomPacketPayload> PayloadRegistrar	PayloadRegistrar.playToClient(CustomPacketPayload.Type<T> type, StreamCodec<? super RegistryFriendlyByteBuf,T> codec)	Registers a client-bound payload for the play phase without a handler.
<T extends CustomPacketPayload> PayloadRegistrar	PayloadRegistrar.playToClient(CustomPacketPayload.Type<T> type, StreamCodec<? super RegistryFriendlyByteBuf,T> codec, IPayloadHandler<T> handler)	Registers a client-bound payload for the play phase.
<T extends CustomPacketPayload> PayloadRegistrar	PayloadRegistrar.playToServer(CustomPacketPayload.Type<T> type, StreamCodec<? super RegistryFriendlyByteBuf,T> codec, IPayloadHandler<T> handler)	Registers a server-bound payload for the play phase.
static <T extends CustomPacketPayload, B extends FriendlyByteBuf> void	NetworkRegistry.register(CustomPacketPayload.Type<T> type, StreamCodec<? super B,T> codec, @Nullable IPayloadHandler<T> serverHandler, @Nullable IPayloadHandler<T> clientHandler, List<ConnectionProtocol> protocols, Optional<PacketFlow> flow, String version, boolean optional)	Registers a new payload.
private <T extends CustomPacketPayload, B extends FriendlyByteBuf> void	PayloadRegistrar.register(CustomPacketPayload.Type<T> type, StreamCodec<? super B,T> codec, @Nullable IPayloadHandler<T> serverHandler, @Nullable IPayloadHandler<T> clientHandler, List<ConnectionProtocol> protocols, Optional<PacketFlow> flow, String version, boolean optional)
protected static <T extends CustomPacketPayload> void	NetworkRegistry.registerHandler(Map<ConnectionProtocol,Map<ResourceLocation,IPayloadHandler<?>>> handlers, ConnectionProtocol protocol, PacketFlow flow, CustomPacketPayload.Type<T> type, IPayloadHandler<T> handler)

Methods in net.neoforged.neoforge.network.registration that return types with arguments of type CustomPacketPayload

Modifier and Type	Method	Description
static @Nullable StreamCodec<? super FriendlyByteBuf,? extends CustomPacketPayload>	NetworkRegistry.getCodec(ResourceLocation id, ConnectionProtocol protocol, PacketFlow flow)	Attempts to retrieve the StreamCodec for a non-vanilla payload.

Methods in net.neoforged.neoforge.network.registration with parameters of type CustomPacketPayload

Modifier and Type	Method	Description
static boolean	NetworkRegistry.isModdedPayload(CustomPacketPayload payload)	Checks if a payload is a modded payload.