net.minecraftforge.fml.network

Class NetworkHooks

java.lang.Object

net.minecraftforge.fml.network.NetworkHooks

public class NetworkHooks
extends java.lang.Object

Field Summary

Fields

Modifier and Type	Field and Description
private static org.apache.logging.log4j.Logger	LOGGER
private static it.unimi.dsi.fastutil.ints.Int2ObjectMap<DimensionType>	trackingMap

Constructor Summary

Constructors

Constructor and Description
NetworkHooks()

Method Summary

Modifier and Type	Method and Description
(package private) static void	addCachedDimensionType(DimensionType dimensionType, ResourceLocation dimName)
static ConnectionType	getConnectionType(java.util.function.Supplier<NetworkManager> connection)
static DimensionType	getDummyDimType(int dimension)
static IPacket<?>	getEntitySpawningPacket(Entity entity)
static java.lang.String	getFMLVersion(java.lang.String ip)
static void	handleClientLoginSuccess(NetworkManager manager)
static boolean	onCustomPayload(ICustomPacket<?> packet, NetworkManager manager)
static void	openGui(ServerPlayerEntity player, INamedContainerProvider containerSupplier) Request to open a GUI on the client, from the server Refer to net.minecraftforge.fml.ExtensionPoint#GUIFACTORY for how to provide a function to consume these GUI requests on the client.
static void	openGui(ServerPlayerEntity player, INamedContainerProvider containerSupplier, BlockPos pos) Request to open a GUI on the client, from the server Refer to net.minecraftforge.fml.ExtensionPoint#GUIFACTORY for how to provide a function to consume these GUI requests on the client.
static void	openGui(ServerPlayerEntity player, INamedContainerProvider containerSupplier, java.util.function.Consumer<PacketBuffer> extraDataWriter) Request to open a GUI on the client, from the server Refer to net.minecraftforge.fml.ExtensionPoint#GUIFACTORY for how to provide a function to consume these GUI requests on the client.
static void	registerClientLoginChannel(NetworkManager manager)
static void	registerServerLoginChannel(NetworkManager manager, CHandshakePacket packet)
static void	sendDimensionDataPacket(NetworkManager manager, ServerPlayerEntity player)
static void	sendMCRegistryPackets(NetworkManager manager, java.lang.String direction)
static boolean	tickNegotiation(ServerLoginNetHandler netHandlerLoginServer, NetworkManager networkManager, ServerPlayerEntity player)
static void	validatePacketDirection(NetworkDirection packetDirection, java.util.Optional<NetworkDirection> expectedDirection, NetworkManager connection)
private static boolean	validateSideForProcessing(ICustomPacket<?> packet, NetworkInstance ni, NetworkManager manager)

Methods inherited from class java.lang.Object

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

Field Detail

LOGGER

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

trackingMap

private static it.unimi.dsi.fastutil.ints.Int2ObjectMap<DimensionType> trackingMap

Constructor Detail

NetworkHooks

public NetworkHooks()

Method Detail

getFMLVersion

public static java.lang.String getFMLVersion(java.lang.String ip)

getConnectionType

public static ConnectionType getConnectionType(java.util.function.Supplier<NetworkManager> connection)

getEntitySpawningPacket

public static IPacket<?> getEntitySpawningPacket(Entity entity)

onCustomPayload

public static boolean onCustomPayload(ICustomPacket<?> packet,
                                      NetworkManager manager)

validateSideForProcessing

private static boolean validateSideForProcessing(ICustomPacket<?> packet,
                                                 NetworkInstance ni,
                                                 NetworkManager manager)

validatePacketDirection

public static void validatePacketDirection(NetworkDirection packetDirection,
                                           java.util.Optional<NetworkDirection> expectedDirection,
                                           NetworkManager connection)

registerServerLoginChannel

public static void registerServerLoginChannel(NetworkManager manager,
                                              CHandshakePacket packet)

registerClientLoginChannel

public static void registerClientLoginChannel(NetworkManager manager)

sendMCRegistryPackets

public static void sendMCRegistryPackets(NetworkManager manager,
                                         java.lang.String direction)

sendDimensionDataPacket

public static void sendDimensionDataPacket(NetworkManager manager,
                                           ServerPlayerEntity player)

handleClientLoginSuccess

public static void handleClientLoginSuccess(NetworkManager manager)

tickNegotiation

public static boolean tickNegotiation(ServerLoginNetHandler netHandlerLoginServer,
                                      NetworkManager networkManager,
                                      ServerPlayerEntity player)

openGui

public static void openGui(ServerPlayerEntity player,
                           INamedContainerProvider containerSupplier)

Request to open a GUI on the client, from the server Refer to net.minecraftforge.fml.ExtensionPoint#GUIFACTORY for how to provide a function to consume these GUI requests on the client. The IInteractionObject#getGuiID() is treated as a ResourceLocation. It should refer to a valid modId namespace, to trigger opening on the client. The namespace is directly used to lookup the modId in the client side.

Parameters:

player - The player to open the GUI for

containerSupplier - A supplier of container properties including the registry name of the container

openGui

public static void openGui(ServerPlayerEntity player,
                           INamedContainerProvider containerSupplier,
                           BlockPos pos)

Request to open a GUI on the client, from the server Refer to net.minecraftforge.fml.ExtensionPoint#GUIFACTORY for how to provide a function to consume these GUI requests on the client. The IInteractionObject#getGuiID() is treated as a ResourceLocation. It should refer to a valid modId namespace, to trigger opening on the client. The namespace is directly used to lookup the modId in the client side.

Parameters:

player - The player to open the GUI for

containerSupplier - A supplier of container properties including the registry name of the container

pos - A block pos, which will be encoded into the auxillary data for this request

openGui

public static void openGui(ServerPlayerEntity player,
                           INamedContainerProvider containerSupplier,
                           java.util.function.Consumer<PacketBuffer> extraDataWriter)

Request to open a GUI on the client, from the server Refer to net.minecraftforge.fml.ExtensionPoint#GUIFACTORY for how to provide a function to consume these GUI requests on the client. The IInteractionObject#getGuiID() is treated as a ResourceLocation. It should refer to a valid modId namespace, to trigger opening on the client. The namespace is directly used to lookup the modId in the client side. The maximum size for #extraDataWriter is 32600 bytes.

Parameters:

player - The player to open the GUI for

containerSupplier - A supplier of container properties including the registry name of the container

extraDataWriter - Consumer to write any additional data the GUI needs

getDummyDimType

public static DimensionType getDummyDimType(int dimension)

addCachedDimensionType

static void addCachedDimensionType(DimensionType dimensionType,
                                   ResourceLocation dimName)