net.minecraftforge.fml.network

Class NetworkRegistry

java.lang.Object

net.minecraftforge.fml.network.NetworkRegistry

public class NetworkRegistry
extends java.lang.Object

The network registry. Tracks channels on behalf of mods.

Nested Class Summary

Nested Classes

Modifier and Type	Class and Description
static class	NetworkRegistry.ChannelBuilder Builder for constructing network channels using a builder style API.
static class	NetworkRegistry.LoginPayload Tracks individual outbound messages for dispatch to clients during login handling.

Field Summary

Fields

Modifier and Type	Field and Description
static java.lang.String	ABSENT Special value for clientAcceptedVersions and serverAcceptedVersions predicates indicating the other side lacks this channel.
static java.lang.String	ACCEPTVANILLA

Constructor Summary

Constructors

Constructor and Description
NetworkRegistry()

Method Summary

Modifier and Type	Method and Description
static boolean	acceptsVanillaClientConnections()
static boolean	canConnectToVanillaServer()
static boolean	checkListPingCompatibilityForClient(java.util.Map<ResourceLocation,org.apache.commons.lang3.tuple.Pair<java.lang.String,java.lang.Boolean>> incoming)
static java.util.List<java.lang.String>	getClientNonVanillaNetworkMods()
static java.util.List<java.lang.String>	getServerNonVanillaNetworkMods()
boolean	isLocked()
static void	lock()
static EventNetworkChannel	newEventChannel(ResourceLocation name, java.util.function.Supplier<java.lang.String> networkProtocolVersion, java.util.function.Predicate<java.lang.String> clientAcceptedVersions, java.util.function.Predicate<java.lang.String> serverAcceptedVersions) Create a new EventNetworkChannel.
static SimpleChannel	newSimpleChannel(ResourceLocation name, java.util.function.Supplier<java.lang.String> networkProtocolVersion, java.util.function.Predicate<java.lang.String> clientAcceptedVersions, java.util.function.Predicate<java.lang.String> serverAcceptedVersions) Create a new SimpleChannel.

Methods inherited from class java.lang.Object

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

Field Detail

ABSENT

public static java.lang.String ABSENT

Special value for clientAcceptedVersions and serverAcceptedVersions predicates indicating the other side lacks this channel.

ACCEPTVANILLA

public static java.lang.String ACCEPTVANILLA

Constructor Detail

NetworkRegistry

public NetworkRegistry()

Method Detail

getServerNonVanillaNetworkMods

public static java.util.List<java.lang.String> getServerNonVanillaNetworkMods()

getClientNonVanillaNetworkMods

public static java.util.List<java.lang.String> getClientNonVanillaNetworkMods()

acceptsVanillaClientConnections

public static boolean acceptsVanillaClientConnections()

canConnectToVanillaServer

public static boolean canConnectToVanillaServer()

newSimpleChannel

public static SimpleChannel newSimpleChannel(ResourceLocation name,
                                             java.util.function.Supplier<java.lang.String> networkProtocolVersion,
                                             java.util.function.Predicate<java.lang.String> clientAcceptedVersions,
                                             java.util.function.Predicate<java.lang.String> serverAcceptedVersions)

Create a new SimpleChannel.

Parameters:

name - The registry name for this channel. Must be unique

networkProtocolVersion - The network protocol version string that will be offered to the remote side NetworkRegistry.ChannelBuilder.networkProtocolVersion(Supplier)

clientAcceptedVersions - Called on the client with the networkProtocolVersion string from the server NetworkRegistry.ChannelBuilder.clientAcceptedVersions(Predicate)

serverAcceptedVersions - Called on the server with the networkProtocolVersion string from the client NetworkRegistry.ChannelBuilder.serverAcceptedVersions(Predicate)

Returns:

A new SimpleChannel

See Also:

newSimpleChannel(ResourceLocation, Supplier, Predicate, Predicate)

newEventChannel

public static EventNetworkChannel newEventChannel(ResourceLocation name,
                                                  java.util.function.Supplier<java.lang.String> networkProtocolVersion,
                                                  java.util.function.Predicate<java.lang.String> clientAcceptedVersions,
                                                  java.util.function.Predicate<java.lang.String> serverAcceptedVersions)

Create a new EventNetworkChannel.

Parameters:

name - The registry name for this channel. Must be unique

networkProtocolVersion - The network protocol version string that will be offered to the remote side NetworkRegistry.ChannelBuilder.networkProtocolVersion(Supplier)

clientAcceptedVersions - Called on the client with the networkProtocolVersion string from the server NetworkRegistry.ChannelBuilder.clientAcceptedVersions(Predicate)

serverAcceptedVersions - Called on the server with the networkProtocolVersion string from the client NetworkRegistry.ChannelBuilder.serverAcceptedVersions(Predicate)

Returns:

A new EventNetworkChannel

See Also:

newEventChannel(ResourceLocation, Supplier, Predicate, Predicate)

checkListPingCompatibilityForClient

public static boolean checkListPingCompatibilityForClient(java.util.Map<ResourceLocation,org.apache.commons.lang3.tuple.Pair<java.lang.String,java.lang.Boolean>> incoming)

isLocked

public boolean isLocked()

lock

public static void lock()