org.quiltmc.loader.api.ModMetadata Interface Reference

Representation of a mod's metadata. More...

Inheritance diagram for org.quiltmc.loader.api.ModMetadata:

Classes
interface	ProvidedMod

Public Member Functions
String	id ()
String	group ()
Version	version ()
String	name ()
String	description ()
Collection< ModLicense >	licenses ()
	Gets all licenses that apply to this mod.
Collection< ModContributor >	contributors ()
String	getContactInfo (String key)
	Gets an entry in this mod's contact information.
Map< String, String >	contactInfo ()
Collection< ModDependency >	depends ()
Collection< ModDependency >	breaks ()
default Collection<? extends ProvidedMod >	provides ()
String	icon (int size)
	Gets the path to an icon.
boolean	containsValue (String key)
	Checks for values from a mod's metadata.
LoaderValue	value (String key)
	Gets a value from a mod's metadata.
Map< String, LoaderValue >	values ()
	Gets all available values in a mod's metadata.

Detailed Description

Representation of a mod's metadata.

Member Function Documentation

breaks()

Collection< ModDependency > org.quiltmc.loader.api.ModMetadata.breaks

(

)

Returns

all mod dependencies this mod conflicts with

Implemented in org.quiltmc.loader.impl.metadata.qmj.FabricModMetadataWrapper, and org.quiltmc.loader.impl.metadata.qmj.ProvidedModMetadata.

contactInfo()

Map< String, String > org.quiltmc.loader.api.ModMetadata.contactInfo

(

)

Returns

all contact information entries for this mod

Implemented in org.quiltmc.loader.impl.metadata.qmj.FabricModMetadataWrapper, and org.quiltmc.loader.impl.metadata.qmj.ProvidedModMetadata.

containsValue()

boolean org.quiltmc.loader.api.ModMetadata.containsValue

(

String

key

)

Checks for values from a mod's metadata.

See values() for the specific limitations of this API.

Returns

true if a value if the value exists, or false otherwise.

Implemented in org.quiltmc.loader.impl.metadata.qmj.FabricModMetadataWrapper, and org.quiltmc.loader.impl.metadata.qmj.ProvidedModMetadata.

contributors()

Collection< ModContributor > org.quiltmc.loader.api.ModMetadata.contributors

(

)

Returns

all this mod's contributors

Implemented in org.quiltmc.loader.impl.metadata.qmj.FabricModMetadataWrapper, and org.quiltmc.loader.impl.metadata.qmj.ProvidedModMetadata.

depends()

Collection< ModDependency > org.quiltmc.loader.api.ModMetadata.depends

(

)

Returns

all mod dependencies this mod depends on

Implemented in org.quiltmc.loader.impl.metadata.qmj.FabricModMetadataWrapper, and org.quiltmc.loader.impl.metadata.qmj.ProvidedModMetadata.

description()

String org.quiltmc.loader.api.ModMetadata.description

(

)

Returns

a description of this mod

Implemented in org.quiltmc.loader.impl.metadata.qmj.FabricModMetadataWrapper, and org.quiltmc.loader.impl.metadata.qmj.ProvidedModMetadata.

getContactInfo()

String org.quiltmc.loader.api.ModMetadata.getContactInfo

(

String

key

)

Gets an entry in this mod's contact information.

Parameters

key	the key of the contact information entry

Returns

the value of the contact information or null

Implemented in org.quiltmc.loader.impl.metadata.qmj.FabricModMetadataWrapper, and org.quiltmc.loader.impl.metadata.qmj.ProvidedModMetadata.

group()

String org.quiltmc.loader.api.ModMetadata.group

(

)

Returns

the group of this mod

Implemented in org.quiltmc.loader.impl.metadata.qmj.FabricModMetadataWrapper, and org.quiltmc.loader.impl.metadata.qmj.ProvidedModMetadata.

icon()

String org.quiltmc.loader.api.ModMetadata.icon

(

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, null if no applicable icon was found

Implemented in org.quiltmc.loader.impl.metadata.qmj.FabricModMetadataWrapper, and org.quiltmc.loader.impl.metadata.qmj.ProvidedModMetadata.

id()

String org.quiltmc.loader.api.ModMetadata.id

(

)

Returns

the id of this mod

Implemented in org.quiltmc.loader.impl.metadata.qmj.FabricModMetadataWrapper, and org.quiltmc.loader.impl.metadata.qmj.ProvidedModMetadata.

licenses()

Collection< ModLicense > org.quiltmc.loader.api.ModMetadata.licenses

(

)

Gets all licenses that apply to this mod.

The presence of a license does not imply whether multiple licenses all apply or may be chosen between, consult this mod's licensing for all the details.

Returns

the licenses

Implemented in org.quiltmc.loader.impl.metadata.qmj.FabricModMetadataWrapper, and org.quiltmc.loader.impl.metadata.qmj.ProvidedModMetadata.

name()

String org.quiltmc.loader.api.ModMetadata.name

(

)

Returns

gets the human readable name for this mod

Implemented in org.quiltmc.loader.impl.metadata.qmj.FabricModMetadataWrapper, and org.quiltmc.loader.impl.metadata.qmj.ProvidedModMetadata.

provides()

default Collection<? extends ProvidedMod > org.quiltmc.loader.api.ModMetadata.provides ( )

inline

Returns

all mods that this mod provides.

Implemented in org.quiltmc.loader.impl.metadata.qmj.FabricModMetadataWrapper, and org.quiltmc.loader.impl.metadata.qmj.ProvidedModMetadata.

value()

LoaderValue org.quiltmc.loader.api.ModMetadata.value

(

String

key

)

Gets a value from a mod's metadata.

See values() for the specific limitations of this API.

Returns

a value from a mod's metadata or null if the value does not exist

Implemented in org.quiltmc.loader.impl.metadata.qmj.FabricModMetadataWrapper, and org.quiltmc.loader.impl.metadata.qmj.ProvidedModMetadata.

values()

Map< String, LoaderValue > org.quiltmc.loader.api.ModMetadata.values

(

)

Gets all available values in a mod's metadata.

This can be used to access a place in a mod's metadata where custom values may be defined. Depending on the format of the underlying implementation, this might include all of the data in the original metadata file (such as a quilt.mod.json), or only custom values, or nothing at all.

Returns

all the values

Implemented in org.quiltmc.loader.impl.metadata.qmj.FabricModMetadataWrapper, and org.quiltmc.loader.impl.metadata.qmj.ProvidedModMetadata.

version()

Version org.quiltmc.loader.api.ModMetadata.version

(

)

Returns

the version of this mod

Implemented in org.quiltmc.loader.impl.metadata.qmj.FabricModMetadataWrapper, and org.quiltmc.loader.impl.metadata.qmj.ProvidedModMetadata.

---

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

• src/main/java/org/quiltmc/loader/api/ModMetadata.java