public interface ModMetadata
| Modifier and Type | Method and Description |
|---|---|
boolean |
containsCustomElement(String key)
Deprecated.
Use
containsCustomValue(java.lang.String) instead, this will be removed (can't expose GSON types)! |
boolean |
containsCustomValue(String key)
Returns if the mod's
fabric.mod.json declares a custom value under key. |
Collection<Person> |
getAuthors()
Returns the mod's authors.
|
Collection<ModDependency> |
getBreaks()
Returns the mod's conflicts, with which the Loader will emit a warning.
|
Collection<ModDependency> |
getConflicts()
Returns the mod's conflicts, with which the Loader will terminate loading.
|
ContactInformation |
getContact()
Returns the mod's contact information.
|
Collection<Person> |
getContributors()
Returns the mod's contributors.
|
com.google.gson.JsonElement |
getCustomElement(String key)
Deprecated.
Use
getCustomValue(java.lang.String) instead, this will be removed (can't expose GSON types)! |
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.
|
Collection<ModDependency> |
getDepends()
Returns the mod's required dependencies, without which the Loader will terminate loading.
|
String |
getDescription()
Returns the mod's description.
|
ModEnvironment |
getEnvironment()
Returns the mod's environment.
|
Optional<String> |
getIconPath(int size)
Gets the path to an icon.
|
String |
getId()
Returns the mod's ID.
|
Collection<String> |
getLicense()
Returns the mod's licenses.
|
String |
getName()
Returns the mod's display name.
|
Collection<ModDependency> |
getRecommends()
Returns the mod's recommended dependencies, without which the Loader will emit a warning.
|
Collection<ModDependency> |
getSuggests()
Returns the mod's suggested dependencies.
|
String |
getType()
Returns the type of the mod.
|
Version |
getVersion()
Returns the mod's version.
|
String getType()
The types may be fabric or builtin by default.
String getId()
A mod's id must have only lowercase letters, digits, -, or _.
Version getVersion()
ModEnvironment getEnvironment()
Collection<ModDependency> getDepends()
Collection<ModDependency> getRecommends()
Collection<ModDependency> getSuggests()
Collection<ModDependency> getConflicts()
Collection<ModDependency> getBreaks()
String getName()
String getDescription()
Collection<Person> getAuthors()
Collection<Person> getContributors()
ContactInformation getContact()
Collection<String> getLicense()
Optional<String> getIconPath(int size)
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:
size - the preferred sizeboolean containsCustomValue(String key)
fabric.mod.json declares a custom value under key.key - the keyCustomValue getCustomValue(String key)
fabric.mod.json declared custom value under key.key - the keynull if no such value is presentMap<String,CustomValue> getCustomValues()
Note this map is unmodifiable.
@Deprecated boolean containsCustomElement(String key)
containsCustomValue(java.lang.String) instead, this will be removed (can't expose GSON types)!@Deprecated com.google.gson.JsonElement getCustomElement(String key)
getCustomValue(java.lang.String) instead, this will be removed (can't expose GSON types)!