Package net.neoforged.fml.loading.moddiscovery

Class ModInfo

java.lang.Object

net.neoforged.fml.loading.moddiscovery.ModInfo

All Implemented Interfaces:

IConfigurable, IModInfo

public class ModInfo
extends Object
implements IModInfo, IConfigurable

Nested Class Summary

Nested Classes

Modifier and Type	Class	Description
(package private) class	ModInfo.ModVersion

Nested classes/interfaces inherited from interface net.neoforged.neoforgespi.language.IModInfo

IModInfo.DependencySide, IModInfo.DependencyType, IModInfo.Ordering

Field Summary

Fields

Modifier and Type	Field	Description
private final IConfigurable	config
private static final org.apache.maven.artifact.versioning.DefaultArtifactVersion	DEFAULT_VERSION
private final List<? extends IModInfo.ModVersion>	dependencies
private final String	description
private final String	displayName
private final List<ForgeFeature.Bound>	features
private static final org.slf4j.Logger	LOGGER
private final boolean	logoBlur
private final Optional<String>	logoFile
private final String	modId
private final Optional<URL>	modUrl
private final String	namespace
private final ModFileInfo	owningFile
private final Map<String,Object>	properties
private final Optional<URL>	updateJSONURL
private static final Pattern	VALID_MODID
private static final Pattern	VALID_NAMESPACE
private static final Pattern	VALID_VERSION
private final org.apache.maven.artifact.versioning.ArtifactVersion	version

Fields inherited from interface net.neoforged.neoforgespi.language.IModInfo

UNBOUNDED

Constructor Summary

Constructors

Constructor	Description
ModInfo(ModFileInfo owningFile, IConfigurable config)

Method Summary

Modifier and Type	Method	Description
IConfigurable	getConfig()
<T> Optional<T>	getConfigElement(String... key)
List<? extends IConfigurable>	getConfigList(String... key)
List<? extends IModInfo.ModVersion>	getDependencies()
String	getDescription()
String	getDisplayName()
List<? extends ForgeFeature.Bound>	getForgeFeatures()
IModLanguageLoader	getLoader()	Returns the language loader this mod uses.
boolean	getLogoBlur()
Optional<String>	getLogoFile()
String	getModId()	Returns the mod id.
Map<String,Object>	getModProperties()
Optional<URL>	getModURL()
String	getNamespace()
ModFileInfo	getOwningFile()
Optional<URL>	getUpdateURL()
org.apache.maven.artifact.versioning.ArtifactVersion	getVersion()
private ForgeFeature.Bound	makeBound(Map.Entry<String,Object> e)

Methods inherited from class java.lang.Object

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

Field Details

LOGGER

private static final org.slf4j.Logger LOGGER

DEFAULT_VERSION

private static final org.apache.maven.artifact.versioning.DefaultArtifactVersion DEFAULT_VERSION

VALID_MODID

private static final Pattern VALID_MODID

VALID_NAMESPACE

private static final Pattern VALID_NAMESPACE

VALID_VERSION

private static final Pattern VALID_VERSION

owningFile

private final ModFileInfo owningFile

modId

private final String modId

namespace

private final String namespace

version

private final org.apache.maven.artifact.versioning.ArtifactVersion version

displayName

private final String displayName

description

private final String description

logoFile

private final Optional<String> logoFile

logoBlur

private final boolean logoBlur

updateJSONURL

private final Optional<URL> updateJSONURL

dependencies

private final List<? extends IModInfo.ModVersion> dependencies

features

private final List<ForgeFeature.Bound> features

properties

private final Map<String,Object> properties

config

private final IConfigurable config

modUrl

private final Optional<URL> modUrl

Constructor Details

ModInfo

public ModInfo(ModFileInfo owningFile,
 IConfigurable config)

Method Details

getLoader

public IModLanguageLoader getLoader()

Description copied from interface: IModInfo

Returns the language loader this mod uses.

Specified by:

getLoader in interface IModInfo

Returns:

the language loader this mod uses

getOwningFile

public ModFileInfo getOwningFile()

Specified by:

getOwningFile in interface IModInfo

getModId

public String getModId()

Description copied from interface: IModInfo

Returns the mod id. Mod IDs must satisfy the following requirements:

• be from 2 to 64 characters long
• contain only lowercase letters, digits, underscores, and periods
• each dot-separated section must start with a lowercase letter

Specified by:

getModId in interface IModInfo

Returns:

the mod id

getDisplayName

public String getDisplayName()

Specified by:

getDisplayName in interface IModInfo

getDescription

public String getDescription()

Specified by:

getDescription in interface IModInfo

getVersion

public org.apache.maven.artifact.versioning.ArtifactVersion getVersion()

Specified by:

getVersion in interface IModInfo

getDependencies

public List<? extends IModInfo.ModVersion> getDependencies()

Specified by:

getDependencies in interface IModInfo

getNamespace

public String getNamespace()

Specified by:

getNamespace in interface IModInfo

getModProperties

public Map<String,Object> getModProperties()

Specified by:

getModProperties in interface IModInfo

getUpdateURL

public Optional<URL> getUpdateURL()

Specified by:

getUpdateURL in interface IModInfo

getLogoFile

public Optional<String> getLogoFile()

Specified by:

getLogoFile in interface IModInfo

getLogoBlur

public boolean getLogoBlur()

Specified by:

getLogoBlur in interface IModInfo

getConfig

public IConfigurable getConfig()

Specified by:

getConfig in interface IModInfo

getForgeFeatures

public List<? extends ForgeFeature.Bound> getForgeFeatures()

Specified by:

getForgeFeatures in interface IModInfo

getConfigElement

public <T> Optional<T> getConfigElement(String... key)

Specified by:

getConfigElement in interface IConfigurable

getConfigList

public List<? extends IConfigurable> getConfigList(String... key)

Specified by:

getConfigList in interface IConfigurable

getModURL

public Optional<URL> getModURL()

Specified by:

getModURL in interface IModInfo

makeBound

private ForgeFeature.Bound makeBound(Map.Entry<String,Object> e)