Package net.minecraftforge.fml

Class ModContainer

java.lang.Object

net.minecraftforge.fml.ModContainer

Direct Known Subclasses:

FMLModContainer, LowCodeModContainer, MinecraftModContainer, ModLoader.ErroredModContainer

public abstract class ModContainer
extends Object

The container that wraps around mods in the system.

The philosophy is that individual mod implementation technologies should not impact the actual loading and management of mod code. This class provides a mechanism by which we can wrap actual mod code so that the loader and other facilities can treat mods at arms length.

Field Summary

Fields

Modifier and Type	Field	Description
protected final Map<ModLoadingStage,Runnable>	activityMap
protected Optional<Consumer<IConfigEvent>>	configHandler
protected final EnumMap<ModConfig.Type,ModConfig>	configs
protected Supplier<?>	contextExtension
protected final Map<Class<? extends IExtensionPoint<?>>,Supplier<?>>	extensionPoints
protected final String	modId
protected final net.minecraftforge.forgespi.language.IModInfo	modInfo
protected ModLoadingStage	modLoadingStage
protected final String	namespace

Constructor Summary

Constructors

Constructor	Description
ModContainer()	Errored container state, used for filtering.
ModContainer(net.minecraftforge.forgespi.language.IModInfo info)

Method Summary

Modifier and Type	Method	Description
protected <T extends net.minecraftforge.eventbus.api.Event & IModBusEvent> void	acceptEvent(T e)	Accept an arbitrary event for processing by the mod.
void	addConfig(ModConfig modConfig)
static <T extends net.minecraftforge.eventbus.api.Event & IModBusEvent> CompletableFuture<Void>	buildTransitionHandler(ModContainer target, IModStateTransition.EventGenerator<T> eventGenerator, ProgressMeter progressBar, BiFunction<ModLoadingStage,Throwable,ModLoadingStage> stateChangeHandler, Executor executor)
void	dispatchConfigEvent(IConfigEvent event)
ModLoadingStage	getCurrentState()
<T extends Record> Optional<T>	getCustomExtension(Class<? extends IExtensionPoint<T>> point)
abstract Object	getMod()
final String	getModId()
net.minecraftforge.forgespi.language.IModInfo	getModInfo()
final String	getNamespace()
abstract boolean	matches(Object mod)	Does this mod match the supplied mod?
void	registerDisplayTest(String version, BiPredicate<String,Boolean> remoteVersionTest)
void	registerDisplayTest(Supplier<String> suppliedVersion, BiPredicate<String,Boolean> remoteVersionTest)
void	registerDisplayTest(Supplier<IExtensionPoint.DisplayTest> displayTest)
void	registerDisplayTest(IExtensionPoint.DisplayTest displayTest)
<T extends Record & IExtensionPoint<T>> void	registerExtensionPoint(Class<? extends IExtensionPoint<T>> point, Supplier<T> extension)

Methods inherited from class java.lang.Object

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

Field Details

modId

protected final String modId

namespace

protected final String namespace

modInfo

protected final net.minecraftforge.forgespi.language.IModInfo modInfo

modLoadingStage

protected ModLoadingStage modLoadingStage

contextExtension

protected Supplier<?> contextExtension

activityMap

protected final Map<ModLoadingStage,Runnable> activityMap

extensionPoints

protected final Map<Class<? extends IExtensionPoint<?>>,Supplier<?>> extensionPoints

configs

protected final EnumMap<ModConfig.Type,ModConfig> configs

configHandler

protected Optional<Consumer<IConfigEvent>> configHandler

Constructor Details

ModContainer

public ModContainer(net.minecraftforge.forgespi.language.IModInfo info)

ModContainer

ModContainer()

Errored container state, used for filtering. Does nothing.

Method Details

getModId

public final String getModId()

Returns:

the modid for this mod

getNamespace

public final String getNamespace()

Returns:

the resource prefix for the mod

getCurrentState

public ModLoadingStage getCurrentState()

Returns:

The current loading stage for this mod

buildTransitionHandler

public static <T extends net.minecraftforge.eventbus.api.Event & IModBusEvent>
CompletableFuture<Void> buildTransitionHandler(ModContainer target,
 IModStateTransition.EventGenerator<T> eventGenerator,
 ProgressMeter progressBar,
 BiFunction<ModLoadingStage,Throwable,ModLoadingStage> stateChangeHandler,
 Executor executor)

getModInfo

public net.minecraftforge.forgespi.language.IModInfo getModInfo()

getCustomExtension

public <T extends Record> Optional<T> getCustomExtension(Class<? extends IExtensionPoint<T>> point)

registerExtensionPoint

public <T extends Record & IExtensionPoint<T>> void registerExtensionPoint(Class<? extends IExtensionPoint<T>> point,
 Supplier<T> extension)

registerDisplayTest

public void registerDisplayTest(IExtensionPoint.DisplayTest displayTest)

registerDisplayTest

public void registerDisplayTest(Supplier<IExtensionPoint.DisplayTest> displayTest)

registerDisplayTest

public void registerDisplayTest(String version,
 BiPredicate<String,Boolean> remoteVersionTest)

registerDisplayTest

public void registerDisplayTest(Supplier<String> suppliedVersion,
 BiPredicate<String,Boolean> remoteVersionTest)

addConfig

public void addConfig(ModConfig modConfig)

dispatchConfigEvent

public void dispatchConfigEvent(IConfigEvent event)

matches

public abstract boolean matches(Object mod)

Does this mod match the supplied mod?

Parameters:

mod - to compare

Returns:

if the mod matches

getMod

public abstract Object getMod()

Returns:

the mod object instance

acceptEvent

protected <T extends net.minecraftforge.eventbus.api.Event & IModBusEvent>
void acceptEvent(T e)

Accept an arbitrary event for processing by the mod. Probably posted to an event bus in the lower level container.

Parameters:

e - Event to accept