net.minecraftforge.fml.common.event

Class FMLPreInitializationEvent

java.lang.Object

net.minecraftforge.fml.common.event.FMLEvent

net.minecraftforge.fml.common.event.FMLStateEvent

net.minecraftforge.fml.common.event.FMLPreInitializationEvent

public class FMLPreInitializationEvent
extends FMLStateEvent

Called before FMLInitializationEvent during mod startup. This is the first of three commonly called events during mod initialization. Recommended activities: Setup your logging getModLog() Load any configuration data you might have getSuggestedConfigurationFile() Search for a version.properties file and load it getVersionProperties() Configure your ModMetadata programmatically getModMetadata() Discover parts of your mod by using annotation search getAsmData()

Author:

cpw

See Also:

for how to subscribe to this event

Field Summary

Fields

Modifier and Type	Field and Description
private ASMDataTable	asmData
private java.io.File	configurationDir
private ModContainer	modContainer
private ModMetadata	modMetadata
private java.io.File	sourceFile
private java.io.File	suggestedConfigFile

Constructor Summary

Constructors

Constructor and Description
FMLPreInitializationEvent(java.lang.Object... data)

Method Summary

Modifier and Type	Method and Description
void	applyModContainer(ModContainer activeContainer)
ASMDataTable	getAsmData() Get the ASMDataTable for this instance of Minecraft.
java.security.cert.Certificate[]	getFMLSigningCertificates() Deprecated.
java.io.File	getModConfigurationDirectory() Get the main configuration directory for this minecraft instance
org.apache.logging.log4j.Logger	getModLog() Get a logger instance configured to write to the FML Log as a parent, identified by modid.
ModMetadata	getModMetadata() Get the ModMetadata for this mod
LoaderState.ModState	getModState() The current state of the mod
java.io.File	getSourceFile() Get the File the mod was loaded from
java.io.File	getSuggestedConfigurationFile() Get a suggested configuration file for this mod.
java.util.Properties	getVersionProperties() Get a version.properties file as a Properties object from the mod file.

Methods inherited from class net.minecraftforge.fml.common.event.FMLStateEvent

getSide

Methods inherited from class net.minecraftforge.fml.common.event.FMLEvent

description, getEventType

Methods inherited from class java.lang.Object

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

Field Detail

modMetadata

private ModMetadata modMetadata

sourceFile

private java.io.File sourceFile

configurationDir

private java.io.File configurationDir

suggestedConfigFile

private java.io.File suggestedConfigFile

asmData

private ASMDataTable asmData

modContainer

private ModContainer modContainer

Constructor Detail

FMLPreInitializationEvent

public FMLPreInitializationEvent(java.lang.Object... data)

Method Detail

getModState

public LoaderState.ModState getModState()

Description copied from class: FMLStateEvent

The current state of the mod

Specified by:

getModState in class FMLStateEvent

Returns:

The current state of the mod

applyModContainer

public void applyModContainer(ModContainer activeContainer)

Overrides:

applyModContainer in class FMLEvent

getSourceFile

public java.io.File getSourceFile()

Get the File the mod was loaded from

Returns:

The file the mod was loaded from

getModMetadata

public ModMetadata getModMetadata()

Get the ModMetadata for this mod

Returns:

the mod metadata for the mod

getModConfigurationDirectory

public java.io.File getModConfigurationDirectory()

Get the main configuration directory for this minecraft instance

Returns:

the main configuration directory

getSuggestedConfigurationFile

public java.io.File getSuggestedConfigurationFile()

Get a suggested configuration file for this mod. It will be of the form <modid>.cfg

Returns:

A suggested configuration file name for this mod

getAsmData

public ASMDataTable getAsmData()

Get the ASMDataTable for this instance of Minecraft. This is a special structure containing parsing information from FML. It can be searched for annotations parsed out by FML.

Returns:

getVersionProperties

@Nullable
public java.util.Properties getVersionProperties()

Get a version.properties file as a Properties object from the mod file. This can be used to load build-type information such as a unique version number from a properties file shipped as part of the distributable.

Returns:

A properties object if one exists, else null

getModLog

public org.apache.logging.log4j.Logger getModLog()

Get a logger instance configured to write to the FML Log as a parent, identified by modid. Handy for mod logging!

Returns:

A logger

getFMLSigningCertificates

@Deprecated
public java.security.cert.Certificate[] getFMLSigningCertificates()

Deprecated.

Retrieve the FML signing certificates, if any. Validate these against the published FML certificates in your mod, if you wish. Deprecated because mods should NOT trust this code. Rather they should copy this, or something like this, into their own mods.

Returns:

Certificates used to sign FML and Forge