net.minecraftforge.fml.common

Class FMLCommonHandler

java.lang.Object

net.minecraftforge.fml.common.FMLCommonHandler

public class FMLCommonHandler
extends java.lang.Object

The main class for non-obfuscated hook handling code Anything that doesn't require obfuscated or client/server specific code should go in this handler It also contains a reference to the sided handler instance that is valid allowing for common code to access specific properties from the obfuscated world without a direct dependency

Author:

cpw

Field Summary

Fields

Modifier and Type	Field and Description
private java.util.List<java.lang.String>	brandings
private java.util.List<java.lang.String>	brandingsNoMC
private java.util.List<ICrashCallable>	crashCallables
private EventBus	eventBus
private java.util.concurrent.CountDownLatch	exitLatch
private java.util.Set<SaveHandler>	handlerSet
private java.lang.ref.WeakReference<SaveHandler>	handlerToCheck
private static FMLCommonHandler	INSTANCE The singleton
private boolean	noForge
private IFMLSidedHandler	sidedDelegate The delegate for side specific data and functions

Constructor Summary

Constructors

Modifier	Constructor and Description
private	FMLCommonHandler()

Method Summary

Modifier and Type	Method and Description
void	addModToResourcePack(ModContainer container)
java.util.List<java.lang.String>	beginLoading(IFMLSidedHandler handler)
void	bootstrap()
EventBus	bus() Deprecated.
static void	callFuture(java.util.concurrent.FutureTask<?> task)
void	computeBranding()
void	confirmBackupLevelDatUse(SaveHandler handler)
void	enhanceCrashReport(CrashReport crashReport, CrashReportCategory category)
void	exitJava(int exitCode, boolean hardExit) Used to exit from java, with system exit preventions in place.
void	expectServerStopped() Make handleExit() wait for handleServerStopped().
ModContainer	findContainerFor(java.lang.Object mod) Find the container that associates with the supplied mod object
void	fireKeyInput()
void	fireMouseInput()
void	fireNetRegistrationEvent(NetworkManager manager, java.util.Set<java.lang.String> channelSet, java.lang.String channel, Side side)
void	firePlayerChangedDimensionEvent(EntityPlayer player, int fromDim, int toDim)
void	firePlayerCraftingEvent(EntityPlayer player, ItemStack crafted, IInventory craftMatrix)
void	firePlayerItemPickupEvent(EntityPlayer player, EntityItem item, ItemStack clone)
void	firePlayerLoggedIn(EntityPlayer player)
void	firePlayerLoggedOut(EntityPlayer player)
void	firePlayerRespawnEvent(EntityPlayer player, boolean endConquered)
void	firePlayerSmeltedEvent(EntityPlayer player, ItemStack smelted)
void	fireServerConnectionEvent(NetworkManager manager)
void	fireSidedRegistryEvents()
java.util.List<java.lang.String>	getBrandings(boolean includeMC)
INetHandler	getClientPlayHandler()
NetworkManager	getClientToServerNetworkManager()
java.lang.String	getCurrentLanguage()
CompoundDataFixer	getDataFixer()
Side	getEffectiveSide() Return the effective side for the context in the game.
org.apache.logging.log4j.Logger	getFMLLogger() Deprecated. Not used in FML, Mods use your own logger, see FMLPreInitializationEvent.getModLog()
MinecraftServer	getMinecraftServerInstance()
java.lang.String	getModName()
java.io.File	getSavesDirectory()
Side	getSide()
IFMLSidedHandler	getSidedDelegate()
IThreadListener	getWorldThread(INetHandler net)
void	handleExit(int retVal) Delayed System.exit() until the server is actually stopped/done saving.
boolean	handleServerAboutToStart(MinecraftServer server)
boolean	handleServerHandshake(C00Handshake packet, NetworkManager manager) Process initial Handshake packet, kicks players from the server if they are connecting while we are starting up.
void	handleServerStarted()
boolean	handleServerStarting(MinecraftServer server)
void	handleServerStopped()
void	handleServerStopping()
void	handleWorldDataLoad(SaveHandler handler, WorldInfo worldInfo, NBTTagCompound tagCompound)
void	handleWorldDataSave(SaveHandler handler, WorldInfo worldInfo, NBTTagCompound tagCompound)
static FMLCommonHandler	instance()
boolean	isDisplayCloseRequested()
boolean	isDisplayVSyncForced()
java.io.InputStream	loadLanguage(java.util.Map<java.lang.String,java.lang.String> table, java.io.InputStream inputstream) Loads a lang file, first searching for a marker to enable the 'extended' format {escape characters} If the marker is not found it simply returns and let the vanilla code load things.
void	onPlayerPostTick(EntityPlayer player)
void	onPlayerPreTick(EntityPlayer player)
void	onPostClientTick()
void	onPostServerTick()
void	onPostWorldTick(World world) Every tick just after world and other ticks occur
void	onPreClientTick()
void	onPreServerTick()
void	onPreWorldTick(World world) Every tick just before world and other ticks occur
void	onRenderTickEnd(float timer)
void	onRenderTickStart(float timer)
void	onServerStart(MinecraftServer dedicatedServer)
void	onServerStarted()
void	processWindowMessages()
void	queryUser(StartupQuery query)
void	raiseException(java.lang.Throwable exception, java.lang.String message, boolean stopGame) Raise an exception
void	registerCrashCallable(ICrashCallable callable)
void	reloadCreativeSettings()
void	reloadRenderers()
void	reloadSearchTrees()
void	resetClientRecipeBook()
boolean	shouldAllowPlayerLogins()
boolean	shouldServerBeKilledQuietly()
void	showGuiScreen(java.lang.Object clientGuiElement)
java.lang.String	stripSpecialChars(java.lang.String message)

Methods inherited from class java.lang.Object

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

Field Detail

INSTANCE

private static final FMLCommonHandler INSTANCE

The singleton

sidedDelegate

private IFMLSidedHandler sidedDelegate

The delegate for side specific data and functions

noForge

private boolean noForge

brandings

private java.util.List<java.lang.String> brandings

brandingsNoMC

private java.util.List<java.lang.String> brandingsNoMC

crashCallables

private java.util.List<ICrashCallable> crashCallables

handlerSet

private java.util.Set<SaveHandler> handlerSet

handlerToCheck

private java.lang.ref.WeakReference<SaveHandler> handlerToCheck

eventBus

private EventBus eventBus

exitLatch

private volatile java.util.concurrent.CountDownLatch exitLatch

Constructor Detail

FMLCommonHandler

private FMLCommonHandler()

Method Detail

bus

@Deprecated
public EventBus bus()

Deprecated.

The FML event bus. Subscribe here for FML related events

Returns:

the event bus

beginLoading

public java.util.List<java.lang.String> beginLoading(IFMLSidedHandler handler)

instance

public static FMLCommonHandler instance()

Returns:

the instance

findContainerFor

public ModContainer findContainerFor(java.lang.Object mod)

Find the container that associates with the supplied mod object

Parameters:

mod -

getFMLLogger

@Deprecated
public org.apache.logging.log4j.Logger getFMLLogger()

Deprecated. Not used in FML, Mods use your own logger, see FMLPreInitializationEvent.getModLog()

Get the forge mod loader logging instance (goes to the forgemodloader log file)

Returns:

The log instance for the FML log file

getSide

public Side getSide()

getEffectiveSide

public Side getEffectiveSide()

Return the effective side for the context in the game. This is dependent on thread analysis to try and determine whether the code is running in the server or not. Use at your own risk

raiseException

public void raiseException(java.lang.Throwable exception,
                           java.lang.String message,
                           boolean stopGame)

Raise an exception

computeBranding

public void computeBranding()

getBrandings

public java.util.List<java.lang.String> getBrandings(boolean includeMC)

getSidedDelegate

public IFMLSidedHandler getSidedDelegate()

onPostServerTick

public void onPostServerTick()

onPostWorldTick

public void onPostWorldTick(World world)

Every tick just after world and other ticks occur

onPreServerTick

public void onPreServerTick()

onPreWorldTick

public void onPreWorldTick(World world)

Every tick just before world and other ticks occur

handleServerAboutToStart

public boolean handleServerAboutToStart(MinecraftServer server)

handleServerStarting

public boolean handleServerStarting(MinecraftServer server)

handleServerStarted

public void handleServerStarted()

handleServerStopping

public void handleServerStopping()

getSavesDirectory

public java.io.File getSavesDirectory()

getMinecraftServerInstance

public MinecraftServer getMinecraftServerInstance()

showGuiScreen

public void showGuiScreen(java.lang.Object clientGuiElement)

queryUser

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

Throws:

java.lang.InterruptedException

onServerStart

public void onServerStart(MinecraftServer dedicatedServer)

onServerStarted

public void onServerStarted()

onPreClientTick

public void onPreClientTick()

onPostClientTick

public void onPostClientTick()

onRenderTickStart

public void onRenderTickStart(float timer)

onRenderTickEnd

public void onRenderTickEnd(float timer)

onPlayerPreTick

public void onPlayerPreTick(EntityPlayer player)

onPlayerPostTick

public void onPlayerPostTick(EntityPlayer player)

registerCrashCallable

public void registerCrashCallable(ICrashCallable callable)

enhanceCrashReport

public void enhanceCrashReport(CrashReport crashReport,
                               CrashReportCategory category)

handleWorldDataSave

public void handleWorldDataSave(SaveHandler handler,
                                WorldInfo worldInfo,
                                NBTTagCompound tagCompound)

handleWorldDataLoad

public void handleWorldDataLoad(SaveHandler handler,
                                WorldInfo worldInfo,
                                NBTTagCompound tagCompound)

confirmBackupLevelDatUse

public void confirmBackupLevelDatUse(SaveHandler handler)

isDisplayCloseRequested

public boolean isDisplayCloseRequested()

shouldServerBeKilledQuietly

public boolean shouldServerBeKilledQuietly()

expectServerStopped

public void expectServerStopped()

Make handleExit() wait for handleServerStopped(). For internal use only!

handleExit

public void handleExit(int retVal)

Delayed System.exit() until the server is actually stopped/done saving. For internal use only!

Parameters:

retVal - Exit code for System.exit()

handleServerStopped

public void handleServerStopped()

getModName

public java.lang.String getModName()

addModToResourcePack

public void addModToResourcePack(ModContainer container)

getCurrentLanguage

public java.lang.String getCurrentLanguage()

bootstrap

public void bootstrap()

getClientToServerNetworkManager

public NetworkManager getClientToServerNetworkManager()

fireMouseInput

public void fireMouseInput()

fireKeyInput

public void fireKeyInput()

firePlayerChangedDimensionEvent

public void firePlayerChangedDimensionEvent(EntityPlayer player,
                                            int fromDim,
                                            int toDim)

firePlayerLoggedIn

public void firePlayerLoggedIn(EntityPlayer player)

firePlayerLoggedOut

public void firePlayerLoggedOut(EntityPlayer player)

firePlayerRespawnEvent

public void firePlayerRespawnEvent(EntityPlayer player,
                                   boolean endConquered)

firePlayerItemPickupEvent

public void firePlayerItemPickupEvent(EntityPlayer player,
                                      EntityItem item,
                                      ItemStack clone)

firePlayerCraftingEvent

public void firePlayerCraftingEvent(EntityPlayer player,
                                    ItemStack crafted,
                                    IInventory craftMatrix)

firePlayerSmeltedEvent

public void firePlayerSmeltedEvent(EntityPlayer player,
                                   ItemStack smelted)

getClientPlayHandler

public INetHandler getClientPlayHandler()

fireNetRegistrationEvent

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

shouldAllowPlayerLogins

public boolean shouldAllowPlayerLogins()

fireServerConnectionEvent

public void fireServerConnectionEvent(NetworkManager manager)

handleServerHandshake

public boolean handleServerHandshake(C00Handshake packet,
                                     NetworkManager manager)

Process initial Handshake packet, kicks players from the server if they are connecting while we are starting up. Also verifies the client has the FML marker.

Parameters:

packet - Handshake Packet

manager - Network connection

Returns:

True to allow connection, otherwise False.

processWindowMessages

public void processWindowMessages()

exitJava

public void exitJava(int exitCode,
                     boolean hardExit)

Used to exit from java, with system exit preventions in place. Will be tidy about it and just log a message, unless debugging is enabled

Parameters:

exitCode - The exit code

hardExit - Perform a halt instead of an exit (only use when the world is unsavable) - read the warnings at Runtime.halt(int)

getWorldThread

public IThreadListener getWorldThread(INetHandler net)

callFuture

public static void callFuture(java.util.concurrent.FutureTask<?> task)

loadLanguage

@Nullable
public java.io.InputStream loadLanguage(java.util.Map<java.lang.String,java.lang.String> table,
                                                  java.io.InputStream inputstream)
                                           throws java.io.IOException

Loads a lang file, first searching for a marker to enable the 'extended' format {escape characters} If the marker is not found it simply returns and let the vanilla code load things. The Marker is 'PARSE_ESCAPES' by itself on a line starting with '#' as such: #PARSE_ESCAPES

Parameters:

table - The Map to load each key/value pair into.

inputstream - Input stream containing the lang file.

Returns:

A new InputStream that vanilla uses to load normal Lang files, Null if this is a 'enhanced' file and loading is done.

Throws:

java.io.IOException

stripSpecialChars

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

reloadRenderers

public void reloadRenderers()

fireSidedRegistryEvents

public void fireSidedRegistryEvents()

getDataFixer

public CompoundDataFixer getDataFixer()

isDisplayVSyncForced

public boolean isDisplayVSyncForced()

resetClientRecipeBook

public void resetClientRecipeBook()

reloadSearchTrees

public void reloadSearchTrees()

reloadCreativeSettings

public void reloadCreativeSettings()