net.minecraftforge.fml.common

Class Loader

java.lang.Object

net.minecraftforge.fml.common.Loader

public class Loader
extends java.lang.Object

The loader class performs the actual loading of the mod code from disk.

There are several LoaderStates to mod loading, triggered in two different stages from the FML handler code's hooks into the minecraft code.

1. LOADING. Scanning the filesystem for mod containers to load (zips, jars, directories), adding them to the modClassLoader Scanning, the loaded containers for mod classes to load and registering them appropriately.
2. PREINIT. The mod classes are configured, they are sorted into a load order, and instances of the mods are constructed.
3. INIT. The mod instances are initialized. For BaseMod mods, this involves calling the load method.
4. POSTINIT. The mod instances are post initialized. For BaseMod mods this involves calling the modsLoaded method.
5. UP. The Loader is complete
6. ERRORED. The loader encountered an error during the LOADING phase and dropped to this state instead. It will not complete loading from this state, but it attempts to continue loading before abandoning and giving a fatal error.

Phase 1 code triggers the LOADING and PREINIT states. Phase 2 code triggers the INIT and POSTINIT states.

Author:

cpw

Nested Class Summary

Nested Classes

Modifier and Type	Class and Description
private class	Loader.ModIdComparator

Field Summary

Fields

Modifier and Type	Field and Description
private static java.lang.String	build
private java.io.File	canonicalConfigDir The canonical configuration directory
private java.io.File	canonicalModsDir
private ModDiscoverer	discoverer
private com.google.common.collect.ImmutableMap<java.lang.String,java.lang.String>	fmlBrandingProperties
private java.io.File	forcedModFile
private com.google.common.collect.ListMultimap<java.lang.String,ArtifactVersion>	injectedAfter
private com.google.common.collect.ListMultimap<java.lang.String,ArtifactVersion>	injectedBefore
private static java.util.List<java.lang.String>	injectedContainers
private static Loader	instance The singleton instance
private static java.lang.String	major Build information for tracking purposes.
static java.lang.String	MC_VERSION
private static java.lang.String	mccversion
private MCPDummyContainer	mcp
private static java.lang.String	mcpversion
private MinecraftDummyContainer	minecraft
private static java.io.File	minecraftDir
private static java.lang.String	minor
private ModClassLoader	modClassLoader The class loader we load the mods into.
private LoadController	modController
private java.util.List<ModContainer>	mods The sorted list of mods.
private java.util.Map<java.lang.String,ModContainer>	namedMods A named list of mods
private ProgressManager.ProgressBar	progressBar
private static java.lang.String	rev
private com.google.common.collect.ListMultimap<java.lang.String,java.lang.String>	reverseDependencies A reverse dependency graph for mods

Constructor Summary

Constructors

Modifier	Constructor and Description
private	Loader()

Method Summary

Modifier and Type	Method and Description
ModContainer	activeModContainer()
(package private) boolean	checkRemoteModList(java.util.Map<java.lang.String,java.lang.String> modList, Side side)
void	computeDependencies(java.lang.String dependencyString, java.util.Set<ArtifactVersion> requirements, java.util.List<ArtifactVersion> dependencies, java.util.List<ArtifactVersion> dependants) Deprecated. use DependencyParser.parseDependencies(String)
private void	disableRequestedMods()
void	fireRemapEvent(java.util.Map<ResourceLocation,java.util.Map<ResourceLocation,java.lang.Integer[]>> remaps, boolean isFreezing)
java.util.List<ModContainer>	getActiveModList()
ICrashCallable	getCallableCrashInformation()
java.io.File	getConfigDir()
java.lang.String	getCrashInformation()
java.util.Map<java.lang.String,java.lang.String>	getCustomModProperties(java.lang.String modId)
java.util.Map<java.lang.String,java.lang.String>	getFMLBrandingProperties()
java.lang.String	getFMLVersionString()
java.util.Map<java.lang.String,ModContainer>	getIndexedModList()
(package private) java.util.List<ArtifactVersion>	getInjectedAfter(java.lang.String modId)
(package private) java.util.List<ArtifactVersion>	getInjectedBefore(java.lang.String modId)
LoaderState	getLoaderState()
java.lang.String	getMCPVersionString()
java.lang.String	getMCVersionString()
MinecraftDummyContainer	getMinecraftModContainer()
ModClassLoader	getModClassLoader()
java.util.List<ModContainer>	getModList()
com.google.common.collect.BiMap<ModContainer,java.lang.Object>	getModObjectList()
LoaderState.ModState	getModState(ModContainer selectedMod)
com.google.common.collect.BiMap<java.lang.Object,ModContainer>	getReversedModObjectList()
boolean	hasReachedState(LoaderState state)
private void	identifyDuplicates(java.util.List<ModContainer> mods)
private ModDiscoverer	identifyMods(java.util.List<java.lang.String> additionalContainers) The primary loading code The found resources are first loaded into the modClassLoader (always) then scanned for class resources matching the specification above.
private void	initializeLoader()
void	initializeMods()
static void	injectData(java.lang.Object... data)
static Loader	instance()
boolean	isInState(LoaderState state)
static boolean	isModLoaded(java.lang.String modname) Query if we know of a mod named modname
void	loadingComplete()
void	loadMods(java.util.List<java.lang.String> injectedModContainers) Called from the hook to start mod loading.
void	preinitializeMods()
private void	readInjectedDependencies()
void	runtimeDisableMod(java.lang.String modId)
boolean	serverAboutToStart(java.lang.Object server)
void	serverStarted()
boolean	serverStarting(java.lang.Object server)
void	serverStopped()
void	serverStopping()
void	setActiveModContainer(ModContainer container)
void	setupTestHarness(ModContainer... containers) Used to setup a testharness with a single dummy mod instance for use with various testing hooks
private void	sortModList() Sort the mods into a sorted list, using dependency information from the containers.

Methods inherited from class java.lang.Object

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

Field Detail

MC_VERSION

public static final java.lang.String MC_VERSION

See Also:

Constant Field Values

instance

private static Loader instance

The singleton instance

major

private static java.lang.String major

Build information for tracking purposes.

minor

private static java.lang.String minor

rev

private static java.lang.String rev

build

private static java.lang.String build

mccversion

private static java.lang.String mccversion

mcpversion

private static java.lang.String mcpversion

modClassLoader

private ModClassLoader modClassLoader

The class loader we load the mods into.

mods

private java.util.List<ModContainer> mods

The sorted list of mods.

namedMods

private java.util.Map<java.lang.String,ModContainer> namedMods

A named list of mods

reverseDependencies

private com.google.common.collect.ListMultimap<java.lang.String,java.lang.String> reverseDependencies

A reverse dependency graph for mods

canonicalConfigDir

private java.io.File canonicalConfigDir

The canonical configuration directory

canonicalModsDir

private java.io.File canonicalModsDir

modController

private LoadController modController

minecraft

private MinecraftDummyContainer minecraft

mcp

private MCPDummyContainer mcp

minecraftDir

private static java.io.File minecraftDir

injectedContainers

private static java.util.List<java.lang.String> injectedContainers

fmlBrandingProperties

private com.google.common.collect.ImmutableMap<java.lang.String,java.lang.String> fmlBrandingProperties

forcedModFile

private java.io.File forcedModFile

discoverer

private ModDiscoverer discoverer

progressBar

private ProgressManager.ProgressBar progressBar

injectedBefore

private com.google.common.collect.ListMultimap<java.lang.String,ArtifactVersion> injectedBefore

injectedAfter

private com.google.common.collect.ListMultimap<java.lang.String,ArtifactVersion> injectedAfter

Constructor Detail

Loader

private Loader()

Method Detail

instance

public static Loader instance()

injectData

public static void injectData(java.lang.Object... data)

sortModList

private void sortModList()

Sort the mods into a sorted list, using dependency information from the containers. The sorting is performed using a TopologicalSort based on the pre- and post- dependency information provided by the mods.

identifyMods

private ModDiscoverer identifyMods(java.util.List<java.lang.String> additionalContainers)

The primary loading code The found resources are first loaded into the modClassLoader (always) then scanned for class resources matching the specification above. If they provide the Mod annotation, they will be loaded as "FML mods" Finally, if they are successfully loaded as classes, they are then added to the available mod list.

identifyDuplicates

private void identifyDuplicates(java.util.List<ModContainer> mods)

initializeLoader

private void initializeLoader()

getModList

public java.util.List<ModContainer> getModList()

setupTestHarness

public void setupTestHarness(ModContainer... containers)

Used to setup a testharness with a single dummy mod instance for use with various testing hooks

Parameters:

containers - A list of dummy containers that will be returned as "active" for all queries

loadMods

public void loadMods(java.util.List<java.lang.String> injectedModContainers)

Called from the hook to start mod loading. We trigger the identifyMods(List) and Constructing, Preinitalization, and Initalization phases here. Finally, the mod list is frozen completely and is consider immutable from then on.

Parameters:

injectedModContainers - containers to inject

preinitializeMods

public void preinitializeMods()

disableRequestedMods

private void disableRequestedMods()

isModLoaded

public static boolean isModLoaded(java.lang.String modname)

Query if we know of a mod named modname

Parameters:

modname -

Returns:

If the mod is loaded

getConfigDir

public java.io.File getConfigDir()

getCrashInformation

public java.lang.String getCrashInformation()

getFMLVersionString

public java.lang.String getFMLVersionString()

getModClassLoader

public ModClassLoader getModClassLoader()

computeDependencies

@Deprecated
public void computeDependencies(java.lang.String dependencyString,
                                            java.util.Set<ArtifactVersion> requirements,
                                            java.util.List<ArtifactVersion> dependencies,
                                            java.util.List<ArtifactVersion> dependants)

Deprecated. use DependencyParser.parseDependencies(String)

getIndexedModList

public java.util.Map<java.lang.String,ModContainer> getIndexedModList()

initializeMods

public void initializeMods()

getCallableCrashInformation

public ICrashCallable getCallableCrashInformation()

getActiveModList

public java.util.List<ModContainer> getActiveModList()

getModState

public LoaderState.ModState getModState(ModContainer selectedMod)

getMCVersionString

public java.lang.String getMCVersionString()

serverStarting

public boolean serverStarting(java.lang.Object server)

serverStarted

public void serverStarted()

serverStopping

public void serverStopping()

getModObjectList

public com.google.common.collect.BiMap<ModContainer,java.lang.Object> getModObjectList()

getReversedModObjectList

public com.google.common.collect.BiMap<java.lang.Object,ModContainer> getReversedModObjectList()

activeModContainer

@Nullable
public ModContainer activeModContainer()

isInState

public boolean isInState(LoaderState state)

getMinecraftModContainer

public MinecraftDummyContainer getMinecraftModContainer()

hasReachedState

public boolean hasReachedState(LoaderState state)

getMCPVersionString

public java.lang.String getMCPVersionString()

serverStopped

public void serverStopped()

serverAboutToStart

public boolean serverAboutToStart(java.lang.Object server)

getFMLBrandingProperties

public java.util.Map<java.lang.String,java.lang.String> getFMLBrandingProperties()

getCustomModProperties

public java.util.Map<java.lang.String,java.lang.String> getCustomModProperties(java.lang.String modId)

checkRemoteModList

boolean checkRemoteModList(java.util.Map<java.lang.String,java.lang.String> modList,
                           Side side)

fireRemapEvent

public void fireRemapEvent(java.util.Map<ResourceLocation,java.util.Map<ResourceLocation,java.lang.Integer[]>> remaps,
                           boolean isFreezing)

runtimeDisableMod

public void runtimeDisableMod(java.lang.String modId)

loadingComplete

public void loadingComplete()

readInjectedDependencies

private void readInjectedDependencies()

getInjectedBefore

java.util.List<ArtifactVersion> getInjectedBefore(java.lang.String modId)

getInjectedAfter

java.util.List<ArtifactVersion> getInjectedAfter(java.lang.String modId)

getLoaderState

public final LoaderState getLoaderState()

setActiveModContainer

public void setActiveModContainer(@Nullable
                                  ModContainer container)