net.minecraftforge.fml.client

Class FMLClientHandler

java.lang.Object

net.minecraftforge.fml.client.FMLClientHandler

All Implemented Interfaces:

IFMLSidedHandler

public class FMLClientHandler
extends java.lang.Object
implements IFMLSidedHandler

Handles primary communication from hooked code into the system The FML entry point is beginMinecraftLoading(Minecraft, List, IReloadableResourceManager, MetadataSerializer) called from Minecraft Obfuscated code should focus on this class and other members of the "server" (or "client") code The actual mod loading is handled at arms length by Loader It is expected that a similar class will exist for each target environment: Bukkit and Client side. It should not be directly modified.

Author:

cpw

Field Summary

Fields

Modifier and Type	Field and Description
private static java.lang.String	ALLOWED_CHARS
private java.util.Set<java.lang.String>	badTextureDomains
private com.google.common.collect.Table<java.lang.String,java.lang.String,java.util.Set<ResourceLocation>>	brokenTextures
private Minecraft	client A reference to the server itself
private CloudRenderer	cloudRenderer
private java.lang.ref.WeakReference<NetHandlerPlayClient>	currentPlayClient
private static com.google.common.base.CharMatcher	DISALLOWED_CHAR_MATCHER
private IDisplayableError	errorToDisplay
private java.util.Map<ServerStatusResponse,com.google.gson.JsonObject>	extraServerListData
private com.google.common.collect.BiMap<ModContainer,IModGuiFactory>	guiFactories
private static ResourceLocation	iconSheet
private static FMLClientHandler	INSTANCE The singleton
private boolean	loading
private MetadataSerializer	metaSerializer
private com.google.common.collect.SetMultimap<java.lang.String,ResourceLocation>	missingTextures
private MissingModsException	modsMissing Deprecated.
private DummyModContainer	optifineContainer
private java.util.List<IResourcePack>	resourcePackList
private java.util.Map<java.lang.String,IResourcePack>	resourcePackMap
private java.util.Map<ServerData,ExtendedServerListData>	serverDataTag
private boolean	serverShouldBeKilledQuietly
private static java.util.concurrent.CountDownLatch	startupConnectionData

Constructor Summary

Constructors

Constructor and Description
FMLClientHandler()

Method Summary

Modifier and Type	Method and Description
void	addModAsResource(ModContainer container)
void	addSpecialModEntries(java.util.ArrayList<ModContainer> mods)
void	allowLogins()
void	beginMinecraftLoading(Minecraft minecraft, java.util.List<IResourcePack> resourcePackList, IReloadableResourceManager resourceManager, MetadataSerializer metaSerializer) Called to start the whole game off
void	beginServerLoading(MinecraftServer server)
void	bindServerListData(ServerData data, ServerStatusResponse originalResponse)
void	captureAdditionalData(ServerStatusResponse serverstatusresponse, com.google.gson.JsonObject jsonobject)
void	connectToRealmsServer(java.lang.String host, int port)
void	connectToServer(GuiScreen guiMultiplayer, ServerData serverEntry)
void	connectToServerAtStartup(java.lang.String host, int port)
private void	detectOptifine()
void	displayGuiScreen(EntityPlayer player, GuiScreen gui)
void	displayMissingMods(java.lang.Object modMissingPacket) Deprecated.
java.lang.String	enhanceServerListEntry(ServerListEntryNormal serverListEntry, ServerData serverEntry, int x, int width, int y, int relativeMouseX, int relativeMouseY)
void	extendModList()
void	finishMinecraftLoading() Called a bit later on during initialization to finish loading mods Also initializes key bindings
void	finishServerLoading()
void	fireNetRegistrationEvent(EventBus bus, NetworkManager manager, java.util.Set<java.lang.String> channelSet, java.lang.String channel, Side side)
void	fireSidedRegistryEvents()
java.lang.String	fixDescription(java.lang.String description)
java.util.List<java.lang.String>	getAdditionalBrandingInformation()
Minecraft	getClient() Get the server instance
EntityPlayerSP	getClientPlayerEntity()
INetHandler	getClientPlayHandler()
NetworkManager	getClientToServerNetworkManager()
private CloudRenderer	getCloudRenderer()
java.lang.String	getCurrentLanguage()
CompoundDataFixer	getDataFixer()
IModGuiFactory	getGuiFactoryFor(ModContainer selectedMod)
IResourcePack	getResourcePackFor(java.lang.String modId)
java.io.File	getSavesDir()
java.io.File	getSavesDirectory()
MinecraftServer	getServer()
Side	getSide()
WorldClient	getWorldClient()
IThreadListener	getWorldThread(INetHandler net)
void	haltGame(java.lang.String message, java.lang.Throwable t)
void	handleClientWorldClosing(WorldClient world)
boolean	handleLoadingScreen(ScaledResolution scaledResolution)
boolean	hasError()
boolean	hasOptifine()
static FMLClientHandler	instance()
boolean	isDisplayCloseRequested()
boolean	isDisplayVSyncForced()
boolean	isGUIOpen(java.lang.Class<? extends GuiScreen> gui) Is this GUI type open?
boolean	isLoading() If the client is in the midst of loading, we disable saving so that custom settings aren't wiped out
void	logMissingTextureErrors()
void	onInitializationComplete()
void	processWindowMessages()
void	queryUser(StartupQuery query)
void	refreshResources(IResourceType... inclusion)
void	refreshResources(java.util.function.Predicate<IResourceType> resourcePredicate)
void	reloadCreativeSettings()
void	reloadRenderers()
void	reloadSearchTrees()
boolean	renderClouds(int cloudTicks, float partialTicks)
void	resetClientRecipeBook()
com.google.common.util.concurrent.ListenableFuture<java.lang.Object>	scheduleResourcesRefresh(IResourceType... inclusion)
com.google.common.util.concurrent.ListenableFuture<java.lang.Object>	scheduleResourcesRefresh(java.util.function.Predicate<IResourceType> resourcePredicate)
void	serverStopped()
void	setPlayClient(NetHandlerPlayClient netHandlerPlayClient)
void	setupServerList()
boolean	shouldAllowPlayerLogins()
boolean	shouldServerShouldBeKilledQuietly()
void	showGuiScreen(java.lang.Object clientGuiElement)
void	showInGameModOptions(GuiIngameMenu guiIngameMenu)
void	startIntegratedServer(java.lang.String id, java.lang.String name, WorldSettings settings)
java.lang.String	stripSpecialChars(java.lang.String message)
void	trackBrokenTexture(ResourceLocation resourceLocation, java.lang.String error)
void	trackMissingTexture(ResourceLocation resourceLocation)
void	tryLoadExistingWorld(GuiWorldSelection selectWorldGUI, WorldSummary comparator)
void	updateCloudSettings()

Methods inherited from class java.lang.Object

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

Field Detail

INSTANCE

private static final FMLClientHandler INSTANCE

The singleton

client

private Minecraft client

A reference to the server itself

optifineContainer

private DummyModContainer optifineContainer

modsMissing

@Deprecated
private MissingModsException modsMissing

Deprecated.

loading

private boolean loading

errorToDisplay

@Nullable
private IDisplayableError errorToDisplay

serverShouldBeKilledQuietly

private boolean serverShouldBeKilledQuietly

resourcePackList

private java.util.List<IResourcePack> resourcePackList

metaSerializer

private MetadataSerializer metaSerializer

resourcePackMap

private java.util.Map<java.lang.String,IResourcePack> resourcePackMap

guiFactories

private com.google.common.collect.BiMap<ModContainer,IModGuiFactory> guiFactories

extraServerListData

private java.util.Map<ServerStatusResponse,com.google.gson.JsonObject> extraServerListData

serverDataTag

private java.util.Map<ServerData,ExtendedServerListData> serverDataTag

currentPlayClient

private java.lang.ref.WeakReference<NetHandlerPlayClient> currentPlayClient

cloudRenderer

private CloudRenderer cloudRenderer

iconSheet

private static final ResourceLocation iconSheet

startupConnectionData

private static final java.util.concurrent.CountDownLatch startupConnectionData

missingTextures

private com.google.common.collect.SetMultimap<java.lang.String,ResourceLocation> missingTextures

badTextureDomains

private java.util.Set<java.lang.String> badTextureDomains

brokenTextures

private com.google.common.collect.Table<java.lang.String,java.lang.String,java.util.Set<ResourceLocation>> brokenTextures

ALLOWED_CHARS

private static final java.lang.String ALLOWED_CHARS

See Also:

Constant Field Values

DISALLOWED_CHAR_MATCHER

private static final com.google.common.base.CharMatcher DISALLOWED_CHAR_MATCHER

Constructor Detail

FMLClientHandler

public FMLClientHandler()

Method Detail

beginMinecraftLoading

public void beginMinecraftLoading(Minecraft minecraft,
                                  java.util.List<IResourcePack> resourcePackList,
                                  IReloadableResourceManager resourceManager,
                                  MetadataSerializer metaSerializer)

Called to start the whole game off

Parameters:

minecraft - The minecraft instance being launched

resourcePackList - The resource pack list we will populate with mods

resourceManager - The resource manager

detectOptifine

private void detectOptifine()

haltGame

public void haltGame(java.lang.String message,
                     java.lang.Throwable t)

Specified by:

haltGame in interface IFMLSidedHandler

hasError

public boolean hasError()

finishMinecraftLoading

public void finishMinecraftLoading()

Called a bit later on during initialization to finish loading mods Also initializes key bindings

extendModList

public void extendModList()

onInitializationComplete

public void onInitializationComplete()

getClient

public Minecraft getClient()

Get the server instance

instance

public static FMLClientHandler instance()

Returns:

the instance

displayGuiScreen

public void displayGuiScreen(EntityPlayer player,
                             GuiScreen gui)

Parameters:

player -

gui -

addSpecialModEntries

public void addSpecialModEntries(java.util.ArrayList<ModContainer> mods)

Parameters:

mods -

getAdditionalBrandingInformation

public java.util.List<java.lang.String> getAdditionalBrandingInformation()

Specified by:

getAdditionalBrandingInformation in interface IFMLSidedHandler

getSide

public Side getSide()

Specified by:

getSide in interface IFMLSidedHandler

hasOptifine

public boolean hasOptifine()

showGuiScreen

public void showGuiScreen(@Nullable
                          java.lang.Object clientGuiElement)

Specified by:

showGuiScreen in interface IFMLSidedHandler

queryUser

public void queryUser(StartupQuery query)
               throws java.lang.InterruptedException

Specified by:

queryUser in interface IFMLSidedHandler

Throws:

java.lang.InterruptedException

handleLoadingScreen

public boolean handleLoadingScreen(ScaledResolution scaledResolution)
                            throws java.io.IOException

Throws:

java.io.IOException

getWorldClient

public WorldClient getWorldClient()

getClientPlayerEntity

public EntityPlayerSP getClientPlayerEntity()

beginServerLoading

public void beginServerLoading(MinecraftServer server)

Specified by:

beginServerLoading in interface IFMLSidedHandler

finishServerLoading

public void finishServerLoading()

Specified by:

finishServerLoading in interface IFMLSidedHandler

getSavesDirectory

public java.io.File getSavesDirectory()

Specified by:

getSavesDirectory in interface IFMLSidedHandler

getServer

public MinecraftServer getServer()

Specified by:

getServer in interface IFMLSidedHandler

displayMissingMods

@Deprecated
public void displayMissingMods(java.lang.Object modMissingPacket)

Deprecated.

TODO remove in 1.13

isLoading

public boolean isLoading()

If the client is in the midst of loading, we disable saving so that custom settings aren't wiped out

isDisplayCloseRequested

public boolean isDisplayCloseRequested()

Specified by:

isDisplayCloseRequested in interface IFMLSidedHandler

shouldServerShouldBeKilledQuietly

public boolean shouldServerShouldBeKilledQuietly()

Specified by:

shouldServerShouldBeKilledQuietly in interface IFMLSidedHandler

isGUIOpen

public boolean isGUIOpen(java.lang.Class<? extends GuiScreen> gui)

Is this GUI type open?

Parameters:

gui - The type of GUI to test for

Returns:

if a GUI of this type is open

addModAsResource

public void addModAsResource(ModContainer container)

Specified by:

addModAsResource in interface IFMLSidedHandler

getResourcePackFor

public IResourcePack getResourcePackFor(java.lang.String modId)

getCurrentLanguage

public java.lang.String getCurrentLanguage()

Specified by:

getCurrentLanguage in interface IFMLSidedHandler

serverStopped

public void serverStopped()

Specified by:

serverStopped in interface IFMLSidedHandler

getClientPlayHandler

public INetHandler getClientPlayHandler()

Specified by:

getClientPlayHandler in interface IFMLSidedHandler

getClientToServerNetworkManager

public NetworkManager getClientToServerNetworkManager()

Specified by:

getClientToServerNetworkManager in interface IFMLSidedHandler

handleClientWorldClosing

public void handleClientWorldClosing(WorldClient world)

startIntegratedServer

public void startIntegratedServer(java.lang.String id,
                                  java.lang.String name,
                                  WorldSettings settings)

getSavesDir

public java.io.File getSavesDir()

tryLoadExistingWorld

public void tryLoadExistingWorld(GuiWorldSelection selectWorldGUI,
                                 WorldSummary comparator)

showInGameModOptions

public void showInGameModOptions(GuiIngameMenu guiIngameMenu)

getGuiFactoryFor

public IModGuiFactory getGuiFactoryFor(ModContainer selectedMod)

setupServerList

public void setupServerList()

captureAdditionalData

public void captureAdditionalData(ServerStatusResponse serverstatusresponse,
                                  com.google.gson.JsonObject jsonobject)

bindServerListData

public void bindServerListData(ServerData data,
                               ServerStatusResponse originalResponse)

enhanceServerListEntry

@Nullable
public java.lang.String enhanceServerListEntry(ServerListEntryNormal serverListEntry,
                                                         ServerData serverEntry,
                                                         int x,
                                                         int width,
                                                         int y,
                                                         int relativeMouseX,
                                                         int relativeMouseY)

fixDescription

public java.lang.String fixDescription(java.lang.String description)

connectToServerAtStartup

public void connectToServerAtStartup(java.lang.String host,
                                     int port)

connectToServer

public void connectToServer(GuiScreen guiMultiplayer,
                            ServerData serverEntry)

connectToRealmsServer

public void connectToRealmsServer(java.lang.String host,
                                  int port)

setPlayClient

public void setPlayClient(NetHandlerPlayClient netHandlerPlayClient)

fireNetRegistrationEvent

public void fireNetRegistrationEvent(EventBus bus,
                                     NetworkManager manager,
                                     java.util.Set<java.lang.String> channelSet,
                                     java.lang.String channel,
                                     Side side)

Specified by:

fireNetRegistrationEvent in interface IFMLSidedHandler

shouldAllowPlayerLogins

public boolean shouldAllowPlayerLogins()

Specified by:

shouldAllowPlayerLogins in interface IFMLSidedHandler

allowLogins

public void allowLogins()

Specified by:

allowLogins in interface IFMLSidedHandler

getWorldThread

public IThreadListener getWorldThread(INetHandler net)

Specified by:

getWorldThread in interface IFMLSidedHandler

trackMissingTexture

public void trackMissingTexture(ResourceLocation resourceLocation)

trackBrokenTexture

public void trackBrokenTexture(ResourceLocation resourceLocation,
                               java.lang.String error)

logMissingTextureErrors

public void logMissingTextureErrors()

processWindowMessages

public void processWindowMessages()

Specified by:

processWindowMessages in interface IFMLSidedHandler

stripSpecialChars

public java.lang.String stripSpecialChars(java.lang.String message)

Specified by:

stripSpecialChars in interface IFMLSidedHandler

reloadRenderers

public void reloadRenderers()

Specified by:

reloadRenderers in interface IFMLSidedHandler

fireSidedRegistryEvents

public void fireSidedRegistryEvents()

Specified by:

fireSidedRegistryEvents in interface IFMLSidedHandler

getDataFixer

public CompoundDataFixer getDataFixer()

Specified by:

getDataFixer in interface IFMLSidedHandler

isDisplayVSyncForced

public boolean isDisplayVSyncForced()

Specified by:

isDisplayVSyncForced in interface IFMLSidedHandler

resetClientRecipeBook

public void resetClientRecipeBook()

Specified by:

resetClientRecipeBook in interface IFMLSidedHandler

reloadSearchTrees

public void reloadSearchTrees()

Specified by:

reloadSearchTrees in interface IFMLSidedHandler

reloadCreativeSettings

public void reloadCreativeSettings()

Specified by:

reloadCreativeSettings in interface IFMLSidedHandler

getCloudRenderer

private CloudRenderer getCloudRenderer()

updateCloudSettings

public void updateCloudSettings()

renderClouds

public boolean renderClouds(int cloudTicks,
                            float partialTicks)

refreshResources

public void refreshResources(IResourceType... inclusion)

refreshResources

public void refreshResources(java.util.function.Predicate<IResourceType> resourcePredicate)

scheduleResourcesRefresh

public com.google.common.util.concurrent.ListenableFuture<java.lang.Object> scheduleResourcesRefresh(IResourceType... inclusion)

scheduleResourcesRefresh

public com.google.common.util.concurrent.ListenableFuture<java.lang.Object> scheduleResourcesRefresh(java.util.function.Predicate<IResourceType> resourcePredicate)