The metadata of a mod. More...

Inheritance diagram for net.fabricmc.loader.api.metadata.ModMetadata:

Public Member Functions
String	getType ()
	Returns the type of the mod.
String	getId ()
	Returns the mod's ID.
Collection< String >	getProvides ()
	Returns the mod's ID provides.
Version	getVersion ()
	Returns the mod's version.
ModEnvironment	getEnvironment ()
	Returns the mod's environment.
Collection< ModDependency >	getDependencies ()
	Returns all of the mod's dependencies.
default Collection< ModDependency >	getDepends ()
	Returns the mod's required dependencies, without which the Loader will terminate loading.
default Collection< ModDependency >	getRecommends ()
	Returns the mod's recommended dependencies, without which the Loader will emit a warning.
default Collection< ModDependency >	getSuggests ()
	Returns the mod's suggested dependencies.
default Collection< ModDependency >	getConflicts ()
	Returns the mod's conflicts, with which the Loader will emit a warning.
default Collection< ModDependency >	getBreaks ()
	Returns the mod's conflicts, with which the Loader will terminate loading.
String	getName ()
	Returns the mod's display name.
String	getDescription ()
	Returns the mod's description.
Collection< Person >	getAuthors ()
	Returns the mod's authors.
Collection< Person >	getContributors ()
	Returns the mod's contributors.
ContactInformation	getContact ()
	Returns the mod's contact information.
Collection< String >	getLicense ()
	Returns the mod's licenses.
Optional< String >	getIconPath (int size)
	Gets the path to an icon.
boolean	containsCustomValue (String key)
	Returns if the mod's `fabric.mod.json` declares a custom value under `key`.
CustomValue	getCustomValue (String key)
	Returns the mod's `fabric.mod.json` declared custom value under `key`.
Map< String, CustomValue >	getCustomValues ()
	Gets all custom values defined by this mod.
boolean	containsCustomElement (String key)

Detailed Description

The metadata of a mod.

Deprecated: Please use quilt's org.quiltmc.loader.api.ModMetadata instead.

Member Function Documentation

◆ containsCustomElement()

boolean net.fabricmc.loader.api.metadata.ModMetadata.containsCustomElement ( String key )

Deprecated: Use containsCustomValue instead, this will be removed (can't expose GSON types)!

Implemented in org.quiltmc.loader.impl.fabric.metadata.AbstractModMetadata, and org.quiltmc.loader.impl.metadata.GeneralExt2FabricMetadata.

◆ containsCustomValue()

boolean net.fabricmc.loader.api.metadata.ModMetadata.containsCustomValue ( String key )

Returns if the mod's fabric.mod.json declares a custom value under key.

Parameters

key the key

Returns: whether a custom value is present

Implemented in org.quiltmc.loader.impl.fabric.metadata.AbstractModMetadata, org.quiltmc.loader.impl.fabric.metadata.BuiltinModMetadata, and org.quiltmc.loader.impl.metadata.GeneralExt2FabricMetadata.

◆ getAuthors()

Collection< Person > net.fabricmc.loader.api.metadata.ModMetadata.getAuthors ( )

Returns the mod's authors.

Implemented in org.quiltmc.loader.impl.fabric.metadata.BuiltinModMetadata, and org.quiltmc.loader.impl.metadata.GeneralExt2FabricMetadata.

◆ getBreaks()

default Collection< ModDependency > net.fabricmc.loader.api.metadata.ModMetadata.getBreaks ( )

inline

Returns the mod's conflicts, with which the Loader will terminate loading.

Deprecated: Use getDependencies() and filter for ModDependency.Kind#BREAKS instead

Implemented in org.quiltmc.loader.impl.metadata.GeneralExt2FabricMetadata.

◆ getConflicts()

default Collection< ModDependency > net.fabricmc.loader.api.metadata.ModMetadata.getConflicts ( )

inline

Returns the mod's conflicts, with which the Loader will emit a warning.

Deprecated: Use getDependencies() and filter for ModDependency.Kind#CONFLICTS instead

Implemented in org.quiltmc.loader.impl.metadata.GeneralExt2FabricMetadata.

◆ getContact()

ContactInformation net.fabricmc.loader.api.metadata.ModMetadata.getContact ( )

Returns the mod's contact information.

Implemented in org.quiltmc.loader.impl.fabric.metadata.BuiltinModMetadata, and org.quiltmc.loader.impl.metadata.GeneralExt2FabricMetadata.

◆ getContributors()

Collection< Person > net.fabricmc.loader.api.metadata.ModMetadata.getContributors ( )

Returns the mod's contributors.

Implemented in org.quiltmc.loader.impl.fabric.metadata.BuiltinModMetadata, and org.quiltmc.loader.impl.metadata.GeneralExt2FabricMetadata.

◆ getCustomValue()

CustomValue net.fabricmc.loader.api.metadata.ModMetadata.getCustomValue ( String key )

Returns the mod's fabric.mod.json declared custom value under key.

Parameters

key the key

Returns: the custom value, or null if no such value is present

Implemented in org.quiltmc.loader.impl.fabric.metadata.AbstractModMetadata, org.quiltmc.loader.impl.fabric.metadata.BuiltinModMetadata, and org.quiltmc.loader.impl.metadata.GeneralExt2FabricMetadata.

◆ getCustomValues()

Map< String, CustomValue > net.fabricmc.loader.api.metadata.ModMetadata.getCustomValues ( )

Gets all custom values defined by this mod.

Note this map is unmodifiable.

Returns: a map containing the custom values this mod defines.

Implemented in org.quiltmc.loader.impl.fabric.metadata.BuiltinModMetadata, and org.quiltmc.loader.impl.metadata.GeneralExt2FabricMetadata.

◆ getDependencies()

Collection< ModDependency > net.fabricmc.loader.api.metadata.ModMetadata.getDependencies ( )

Returns all of the mod's dependencies.

Implemented in org.quiltmc.loader.impl.fabric.metadata.BuiltinModMetadata, and org.quiltmc.loader.impl.metadata.GeneralExt2FabricMetadata.

◆ getDepends()

default Collection< ModDependency > net.fabricmc.loader.api.metadata.ModMetadata.getDepends ( )

inline

Returns the mod's required dependencies, without which the Loader will terminate loading.

Deprecated: Use getDependencies() and filter for ModDependency.Kind#DEPENDS instead

Implemented in org.quiltmc.loader.impl.metadata.GeneralExt2FabricMetadata.

◆ getDescription()

String net.fabricmc.loader.api.metadata.ModMetadata.getDescription ( )

Returns the mod's description.

Implemented in org.quiltmc.loader.impl.fabric.metadata.BuiltinModMetadata, and org.quiltmc.loader.impl.metadata.GeneralExt2FabricMetadata.

◆ getEnvironment()

ModEnvironment net.fabricmc.loader.api.metadata.ModMetadata.getEnvironment ( )

Returns the mod's environment.

Implemented in org.quiltmc.loader.impl.fabric.metadata.BuiltinModMetadata, and org.quiltmc.loader.impl.metadata.GeneralExt2FabricMetadata.

◆ getIconPath()

Optional< String > net.fabricmc.loader.api.metadata.ModMetadata.getIconPath ( int size )

Gets the path to an icon.

The standard defines icons as square .PNG files, however their dimensions are not defined - in particular, they are not guaranteed to be a power of two.

The preferred size is used in the following manner:

the smallest image larger than or equal to the size is returned, if one is present;
failing that, the largest image is returned.

Parameters

size	the preferred size

Returns: the icon path, if any

Implemented in org.quiltmc.loader.impl.fabric.metadata.BuiltinModMetadata, and org.quiltmc.loader.impl.metadata.GeneralExt2FabricMetadata.

◆ getId()

String net.fabricmc.loader.api.metadata.ModMetadata.getId ( )

Returns the mod's ID.

A mod's id must have only lowercase letters, digits, -, or _.

Returns: the mod's ID.

Implemented in org.quiltmc.loader.impl.fabric.metadata.BuiltinModMetadata, and org.quiltmc.loader.impl.metadata.GeneralExt2FabricMetadata.

◆ getLicense()

Collection< String > net.fabricmc.loader.api.metadata.ModMetadata.getLicense ( )

Returns the mod's licenses.

Implemented in org.quiltmc.loader.impl.fabric.metadata.BuiltinModMetadata, and org.quiltmc.loader.impl.metadata.GeneralExt2FabricMetadata.

◆ getName()

String net.fabricmc.loader.api.metadata.ModMetadata.getName ( )

Returns the mod's display name.

Implemented in org.quiltmc.loader.impl.fabric.metadata.BuiltinModMetadata, and org.quiltmc.loader.impl.metadata.GeneralExt2FabricMetadata.

◆ getProvides()

Collection< String > net.fabricmc.loader.api.metadata.ModMetadata.getProvides ( )

Returns the mod's ID provides.

The aliases follow the same rules as ID

Returns: the mod's ID provides

Implemented in org.quiltmc.loader.impl.fabric.metadata.BuiltinModMetadata, and org.quiltmc.loader.impl.metadata.GeneralExt2FabricMetadata.

◆ getRecommends()

default Collection< ModDependency > net.fabricmc.loader.api.metadata.ModMetadata.getRecommends ( )

inline

Returns the mod's recommended dependencies, without which the Loader will emit a warning.

Deprecated: Use getDependencies() and filter for ModDependency.Kind#RECOMMENDS instead

Implemented in org.quiltmc.loader.impl.metadata.GeneralExt2FabricMetadata.

◆ getSuggests()

default Collection< ModDependency > net.fabricmc.loader.api.metadata.ModMetadata.getSuggests ( )

inline

Returns the mod's suggested dependencies.

Deprecated: Use getDependencies() and filter for ModDependency.Kind#SUGGESTS instead

Implemented in org.quiltmc.loader.impl.metadata.GeneralExt2FabricMetadata.

◆ getType()

String net.fabricmc.loader.api.metadata.ModMetadata.getType ( )

Returns the type of the mod.

The types may be fabric or builtin by default.

Returns: the type of the mod

Implemented in org.quiltmc.loader.impl.fabric.metadata.BuiltinModMetadata, and org.quiltmc.loader.impl.metadata.GeneralExt2FabricMetadata.

◆ getVersion()

Version net.fabricmc.loader.api.metadata.ModMetadata.getVersion ( )

Returns the mod's version.

Implemented in org.quiltmc.loader.impl.fabric.metadata.BuiltinModMetadata, and org.quiltmc.loader.impl.metadata.GeneralExt2FabricMetadata.

The documentation for this interface was generated from the following file:

src/fabric/api/java/net/fabricmc/loader/api/metadata/ModMetadata.java

Public Member Functions

Detailed Description

Member Function Documentation

◆ containsCustomElement()

◆ containsCustomValue()

◆ getAuthors()

◆ getBreaks()

◆ getConflicts()

◆ getContact()

◆ getContributors()

◆ getCustomValue()

◆ getCustomValues()

◆ getDependencies()

◆ getDepends()

◆ getDescription()

◆ getEnvironment()

◆ getIconPath()

◆ getId()

◆ getLicense()

◆ getName()

◆ getProvides()

◆ getRecommends()

◆ getSuggests()

◆ getType()

◆ getVersion()