net.minecraftforge.fml

Class ModLoader

java.lang.Object

net.minecraftforge.fml.ModLoader

public class ModLoader
extends java.lang.Object

Loads mods. Dispatch cycle is seen in #loadMods() and #finishMods() Overall sequence for loadMods is:

CONSTRUCT

Constructs the mod instance. Mods can typically setup basic environment such as Event listeners and Configuration specifications here.

Automated dispatches

Dispatches automated elements : Mod.EventBusSubscriber, RegistryEvent, CapabilityInject and others

CONFIG_LOAD

Dispatches ConfigLoadEvent to mods

COMMON_SETUP

Dispatches FMLCommonSetupEvent to mods

SIDED_SETUP

Dispatches FMLClientSetupEvent or FMLDedicatedServerSetupEvent to mods

Overall sequence for finishMods is:

ENQUEUE_IMC

Dispatches InterModEnqueueEvent to mods, for enqueuing InterModComms messages for other mods to receive subsequently

PROCESS_IMC

Dispatches InterModProcessEvent to mods, for processing InterModComms messages received from other mods prior to this event

COMPLETE

Dispatches FMLLoadCompleteEvent to mods, and completes the mod loading sequence.

Nested Class Summary

Nested Classes

Modifier and Type	Class and Description
private static class	ModLoader.SpacedRunnable

Field Summary

Fields

Modifier and Type	Field and Description
private GatherDataEvent.DataGeneratorConfig	dataGeneratorConfig
private ExistingFileHelper	existingFileHelper
private static ModLoader	INSTANCE
private cpw.mods.modlauncher.TransformingClassLoader	launchClassLoader
private java.util.List<ModLoadingException>	loadingExceptions
private LoadingModList	loadingModList
private java.util.List<ModLoadingWarning>	loadingWarnings
private static org.apache.logging.log4j.Logger	LOGGER
private java.util.Optional<java.util.function.Consumer<java.lang.String>>	statusConsumer

Constructor Summary

Constructors

Modifier	Constructor and Description
private	ModLoader()

Method Summary

Modifier and Type	Method and Description
private void	accumulateErrors(java.util.List<ModLoadingException> errors)
void	addWarning(ModLoadingWarning warning)
private ModContainer	buildModContainerFromTOML(ModFile modFile, cpw.mods.modlauncher.TransformingClassLoader modClassLoader, java.util.Map<java.lang.String,net.minecraftforge.forgespi.language.IModInfo> modInfoMap, java.util.Map.Entry<java.lang.String,? extends net.minecraftforge.forgespi.language.IModLanguageProvider.IModLanguageLoader> idToProviderEntry)
private java.util.List<ModContainer>	buildMods(ModFile modFile, cpw.mods.modlauncher.TransformingClassLoader modClassLoader)
private java.lang.String	computeLanguageList()
private java.lang.String	computeModLauncherServiceList()
private void	dispatchAndHandleError(LifecycleEventProvider event, java.util.concurrent.Executor executor, java.lang.Runnable ticker)
void	finishMods(java.util.concurrent.Executor mainThreadExecutor)
void	gatherAndInitializeMods(java.lang.Runnable ticker)
static ModLoader	get()
java.util.function.Function<ModContainer,ModLifecycleEvent>	getDataGeneratorEvent()
java.util.List<ModLoadingWarning>	getWarnings()
void	loadMods(java.util.concurrent.Executor mainThreadExecutor, java.util.function.Consumer<java.util.function.Consumer<java.util.function.Supplier<net.minecraftforge.eventbus.api.Event>>> preSidedRunnable, java.util.function.Consumer<java.util.function.Consumer<java.util.function.Supplier<net.minecraftforge.eventbus.api.Event>>> postSidedRunnable)
void	postEvent(net.minecraftforge.eventbus.api.Event e)
void	runDataGenerator(java.util.Set<java.lang.String> mods, java.nio.file.Path path, java.util.Collection<java.nio.file.Path> inputs, java.util.Collection<java.nio.file.Path> existingPacks, boolean serverGenerators, boolean clientGenerators, boolean devToolGenerators, boolean reportsGenerator, boolean structureValidator) Deprecated.
void	runDataGenerator(java.util.Set<java.lang.String> mods, java.nio.file.Path path, java.util.Collection<java.nio.file.Path> inputs, java.util.Collection<java.nio.file.Path> existingPacks, boolean serverGenerators, boolean clientGenerators, boolean devToolGenerators, boolean reportsGenerator, boolean structureValidator, boolean flat)

Methods inherited from class java.lang.Object

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

Field Detail

LOGGER

private static final org.apache.logging.log4j.Logger LOGGER

INSTANCE

private static ModLoader INSTANCE

launchClassLoader

private final cpw.mods.modlauncher.TransformingClassLoader launchClassLoader

loadingModList

private final LoadingModList loadingModList

loadingExceptions

private final java.util.List<ModLoadingException> loadingExceptions

loadingWarnings

private final java.util.List<ModLoadingWarning> loadingWarnings

dataGeneratorConfig

private GatherDataEvent.DataGeneratorConfig dataGeneratorConfig

existingFileHelper

private ExistingFileHelper existingFileHelper

statusConsumer

private final java.util.Optional<java.util.function.Consumer<java.lang.String>> statusConsumer

Constructor Detail

ModLoader

private ModLoader()

Method Detail

computeLanguageList

private java.lang.String computeLanguageList()

computeModLauncherServiceList

private java.lang.String computeModLauncherServiceList()

get

public static ModLoader get()

loadMods

public void loadMods(java.util.concurrent.Executor mainThreadExecutor,
                     java.util.function.Consumer<java.util.function.Consumer<java.util.function.Supplier<net.minecraftforge.eventbus.api.Event>>> preSidedRunnable,
                     java.util.function.Consumer<java.util.function.Consumer<java.util.function.Supplier<net.minecraftforge.eventbus.api.Event>>> postSidedRunnable)

gatherAndInitializeMods

public void gatherAndInitializeMods(java.lang.Runnable ticker)

dispatchAndHandleError

private void dispatchAndHandleError(LifecycleEventProvider event,
                                    java.util.concurrent.Executor executor,
                                    java.lang.Runnable ticker)

accumulateErrors

private void accumulateErrors(java.util.List<ModLoadingException> errors)

buildMods

private java.util.List<ModContainer> buildMods(ModFile modFile,
                                               cpw.mods.modlauncher.TransformingClassLoader modClassLoader)

buildModContainerFromTOML

private ModContainer buildModContainerFromTOML(ModFile modFile,
                                               cpw.mods.modlauncher.TransformingClassLoader modClassLoader,
                                               java.util.Map<java.lang.String,net.minecraftforge.forgespi.language.IModInfo> modInfoMap,
                                               java.util.Map.Entry<java.lang.String,? extends net.minecraftforge.forgespi.language.IModLanguageProvider.IModLanguageLoader> idToProviderEntry)

postEvent

public void postEvent(net.minecraftforge.eventbus.api.Event e)

finishMods

public void finishMods(java.util.concurrent.Executor mainThreadExecutor)

getWarnings

public java.util.List<ModLoadingWarning> getWarnings()

addWarning

public void addWarning(ModLoadingWarning warning)

runDataGenerator

@Deprecated
public void runDataGenerator(java.util.Set<java.lang.String> mods,
                                         java.nio.file.Path path,
                                         java.util.Collection<java.nio.file.Path> inputs,
                                         java.util.Collection<java.nio.file.Path> existingPacks,
                                         boolean serverGenerators,
                                         boolean clientGenerators,
                                         boolean devToolGenerators,
                                         boolean reportsGenerator,
                                         boolean structureValidator)

Deprecated.

runDataGenerator

public void runDataGenerator(java.util.Set<java.lang.String> mods,
                             java.nio.file.Path path,
                             java.util.Collection<java.nio.file.Path> inputs,
                             java.util.Collection<java.nio.file.Path> existingPacks,
                             boolean serverGenerators,
                             boolean clientGenerators,
                             boolean devToolGenerators,
                             boolean reportsGenerator,
                             boolean structureValidator,
                             boolean flat)

getDataGeneratorEvent

public java.util.function.Function<ModContainer,ModLifecycleEvent> getDataGeneratorEvent()