YATS/Forge Documentation
 All Classes Namespaces Files Functions Variables Enumerator Pages
cpw.mods.fml.client.FMLClientHandler Class Reference
Inheritance diagram for cpw.mods.fml.client.FMLClientHandler:
cpw.mods.fml.common.IFMLSidedHandler

Public Member Functions

void beginMinecraftLoading (Minecraft minecraft)
 
void haltGame (String message, Throwable t)
 
void finishMinecraftLoading ()
 
void onInitializationComplete ()
 
Minecraft getClient ()
 
Logger getMinecraftLogger ()
 
void displayGuiScreen (EntityPlayer player, GuiScreen gui)
 
void addSpecialModEntries (ArrayList< ModContainer > mods)
 
List< String > getAdditionalBrandingInformation ()
 
Side getSide ()
 
boolean hasOptifine ()
 
void showGuiScreen (Object clientGuiElement)
 
Entity spawnEntityIntoClientWorld (EntityRegistration er, EntitySpawnPacket packet)
 
void adjustEntityLocationOnClient (EntitySpawnAdjustmentPacket packet)
 
void beginServerLoading (MinecraftServer server)
 
void finishServerLoading ()
 
MinecraftServer getServer ()
 
void sendPacket (Packet packet)
 
void displayMissingMods (ModMissingPacket modMissingPacket)
 
boolean isLoading ()
 
void handleTinyPacket (NetHandler handler, Packet131MapData mapData)
 
void setClientCompatibilityLevel (byte compatibilityLevel)
 
byte getClientCompatibilityLevel ()
 
void warnIDMismatch (MapDifference< Integer, ItemData > idDifferences, boolean mayContinue)
 
void callbackIdDifferenceResponse (boolean response)
 
boolean shouldServerShouldBeKilledQuietly ()
 
void disconnectIDMismatch (MapDifference< Integer, ItemData > s, NetHandler toKill, INetworkManager mgr)
 
boolean isGUIOpen (Class<?extends GuiScreen > gui)
 

Static Public Member Functions

static FMLClientHandler instance ()
 

Detailed Description

Handles primary communication from hooked code into the system

The FML entry point is beginMinecraftLoading(Minecraft) 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

Member Function Documentation

void cpw.mods.fml.client.FMLClientHandler.addSpecialModEntries ( ArrayList< ModContainer mods)
Parameters
mods
void cpw.mods.fml.client.FMLClientHandler.adjustEntityLocationOnClient ( EntitySpawnAdjustmentPacket  packet)
void cpw.mods.fml.client.FMLClientHandler.beginMinecraftLoading ( Minecraft  minecraft)

Called to start the whole game off

Parameters
minecraftThe minecraft instance being launched
void cpw.mods.fml.client.FMLClientHandler.beginServerLoading ( MinecraftServer  server)
void cpw.mods.fml.client.FMLClientHandler.callbackIdDifferenceResponse ( boolean  response)
void cpw.mods.fml.client.FMLClientHandler.disconnectIDMismatch ( MapDifference< Integer, ItemData s,
NetHandler  toKill,
INetworkManager  mgr 
)
void cpw.mods.fml.client.FMLClientHandler.displayGuiScreen ( EntityPlayer  player,
GuiScreen  gui 
)
Parameters
player
gui
void cpw.mods.fml.client.FMLClientHandler.displayMissingMods ( ModMissingPacket  modMissingPacket)
void cpw.mods.fml.client.FMLClientHandler.finishMinecraftLoading ( )

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

void cpw.mods.fml.client.FMLClientHandler.finishServerLoading ( )
List<String> cpw.mods.fml.client.FMLClientHandler.getAdditionalBrandingInformation ( )
Minecraft cpw.mods.fml.client.FMLClientHandler.getClient ( )

Get the server instance

byte cpw.mods.fml.client.FMLClientHandler.getClientCompatibilityLevel ( )
Logger cpw.mods.fml.client.FMLClientHandler.getMinecraftLogger ( )

Get a handle to the client's logger instance The client actually doesn't have one- so we return null

MinecraftServer cpw.mods.fml.client.FMLClientHandler.getServer ( )
Side cpw.mods.fml.client.FMLClientHandler.getSide ( )
void cpw.mods.fml.client.FMLClientHandler.haltGame ( String  message,
Throwable  t 
)
void cpw.mods.fml.client.FMLClientHandler.handleTinyPacket ( NetHandler  handler,
Packet131MapData  mapData 
)
boolean cpw.mods.fml.client.FMLClientHandler.hasOptifine ( )
static FMLClientHandler cpw.mods.fml.client.FMLClientHandler.instance ( )
static
Returns
the instance
boolean cpw.mods.fml.client.FMLClientHandler.isGUIOpen ( Class<?extends GuiScreen gui)

Is this GUI type open?

Parameters
guiThe type of GUI to test for
Returns
if a GUI of this type is open
boolean cpw.mods.fml.client.FMLClientHandler.isLoading ( )

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

void cpw.mods.fml.client.FMLClientHandler.onInitializationComplete ( )
void cpw.mods.fml.client.FMLClientHandler.sendPacket ( Packet  packet)
void cpw.mods.fml.client.FMLClientHandler.setClientCompatibilityLevel ( byte  compatibilityLevel)
boolean cpw.mods.fml.client.FMLClientHandler.shouldServerShouldBeKilledQuietly ( )
void cpw.mods.fml.client.FMLClientHandler.showGuiScreen ( Object  clientGuiElement)
Entity cpw.mods.fml.client.FMLClientHandler.spawnEntityIntoClientWorld ( EntityRegistration  er,
EntitySpawnPacket  packet 
)
void cpw.mods.fml.client.FMLClientHandler.warnIDMismatch ( MapDifference< Integer, ItemData idDifferences,
boolean  mayContinue 
)

The documentation for this class was generated from the following file: