Package net.minecraftforge.network

Class PayloadChannel

java.lang.Object

net.minecraftforge.network.Channel<CustomPacketPayload>

net.minecraftforge.network.PayloadChannel

final class PayloadChannel
extends Channel<CustomPacketPayload>

Nested Class Summary

Nested Classes

Modifier and Type	Class	Description
private static final class	PayloadChannel.Builder
private static final record	PayloadChannel.Message<MSG extends CustomPacketPayload,BUF extends FriendlyByteBuf>

Nested classes/interfaces inherited from class net.minecraftforge.network.Channel

Channel.VersionTest

Field Summary

Fields

Modifier and Type	Field	Description
private static final org.apache.logging.log4j.Logger	LOGGER
private static final org.apache.logging.log4j.Marker	MARKER
private final Map<ResourceLocation,PayloadChannel.Message<?,?>>	payloads

Fields inherited from class net.minecraftforge.network.Channel

instance

Constructor Summary

Constructors

Modifier	Constructor	Description
private	PayloadChannel(PayloadChannel.Builder builder)

Method Summary

Modifier and Type	Method	Description
(package private) static PayloadConnection<CustomPacketPayload>	builder(NetworkInstance instance)
void	encode(FriendlyByteBuf out, CustomPacketPayload message)
private void	error(String message)
private PayloadChannel.Message<CustomPacketPayload,FriendlyByteBuf>	get(ResourceLocation type, boolean send)
(package private) ResourceLocation	getName(CustomPacketPayload packet)	Retrieves the channel name to use for the specified packet This typically is the main channel's name, but in some cases you want to specify a custom one.
private void	onPacketReceived(CustomPayloadEvent event)
protected Packet<?>	toVanillaPacket(Connection con, CustomPacketPayload message)

Methods inherited from class net.minecraftforge.network.Channel

getName, getProtocolVersion, isRemotePresent, reply, send, send, validate

Methods inherited from class java.lang.Object

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

Field Details

LOGGER

private static final org.apache.logging.log4j.Logger LOGGER

MARKER

private static final org.apache.logging.log4j.Marker MARKER

payloads

private final Map<ResourceLocation,PayloadChannel.Message<?,?>> payloads

Constructor Details

PayloadChannel

@Internal
private PayloadChannel(PayloadChannel.Builder builder)

Method Details

builder

static PayloadConnection<CustomPacketPayload> builder(NetworkInstance instance)

get

private PayloadChannel.Message<CustomPacketPayload,FriendlyByteBuf> get(ResourceLocation type,
 boolean send)

error

private void error(String message)

onPacketReceived

private void onPacketReceived(CustomPayloadEvent event)

toVanillaPacket

protected Packet<?> toVanillaPacket(Connection con,
 CustomPacketPayload message)

Overrides:

toVanillaPacket in class Channel<CustomPacketPayload>

getName

ResourceLocation getName(CustomPacketPayload packet)

Description copied from class: Channel

Retrieves the channel name to use for the specified packet This typically is the main channel's name, but in some cases you want to specify a custom one. If your channel has children

Overrides:

getName in class Channel<CustomPacketPayload>

encode

public void encode(FriendlyByteBuf out,
 CustomPacketPayload message)

Specified by:

encode in class Channel<CustomPacketPayload>