Class ModInfo

java.lang.Object

dev.puzzleshq.mod.info.ModInfo

public class ModInfo
extends Object

Represents the mod.json of a mod.

Since:

1.0.0

Constructor Summary

Constructors

Constructor	Description
ModInfo(IModFormat format, String displayName, String id, String version, String description, String[] authors, Map<String, org.hjson.JsonValue> metadata, Map<String, EntrypointPair[]> entrypointMap, MixinConfig[] mixinConfigs, String[] accessTransformers, Map<String,Boolean> loadableSides, ModDependency[] dependencies)

Method Summary

Modifier and Type	Method	Description
String[]	getAccessTransformers()	Gets the mods access transformers.
String[]	getAuthors()	Gets the mods authors.
ModDependency[]	getDependencies()	Gets the mods dependencies.
String	getDescription()	Gets the mods description.
String	getDisplayName()	Gets the mods display name.
Map<String, EntrypointPair[]>	getEntrypointMap()	Gets the mods entrypoint map.
IModFormat	getFormat()	Gets the modInfos format.
String	getId()	Gets the mods ID.
Map<String,Boolean>	getLoadableSides()	Gets the sides the mod can be loaded.
Map<String, org.hjson.JsonValue>	getMetadata()	Gets the mods meta data.
MixinConfig[]	getMixinConfigs()	Gets the mods mixin configs.
String	getVersion()	Gets the mods Version.
static ModInfo	readFromString(String contents)	Reads a string to a manipulation file.

Methods inherited from class java.lang.Object

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

Constructor Details

ModInfo

public ModInfo(@Nullable
 IModFormat format,
 String displayName,
 String id,
 String version,
 String description,
 String[] authors,
 Map<String, org.hjson.JsonValue> metadata,
 Map<String, EntrypointPair[]> entrypointMap,
 MixinConfig[] mixinConfigs,
 String[] accessTransformers,
 Map<String,Boolean> loadableSides,
 ModDependency[] dependencies)

Method Details

getDisplayName

public String getDisplayName()

Gets the mods display name.

getId

public String getId()

Gets the mods ID.

getVersion

public String getVersion()

Gets the mods Version.

getDescription

public String getDescription()

Gets the mods description.

getAuthors

public String[] getAuthors()

Gets the mods authors.

Returns:

an array of strings.

getMetadata

public Map<String, org.hjson.JsonValue> getMetadata()

Gets the mods meta data.

Returns:

an Map of String and JsonValue.

getEntrypointMap

public Map<String, EntrypointPair[]> getEntrypointMap()

Gets the mods entrypoint map.

Returns:

a Map the key is the entrypoint name and the value is an array of EntrypointPair.

getMixinConfigs

public MixinConfig[] getMixinConfigs()

Gets the mods mixin configs.

Returns:

an array of MixinConfig.

getAccessTransformers

public String[] getAccessTransformers()

Gets the mods access transformers.

Returns:

an array of String.

getLoadableSides

public Map<String,Boolean> getLoadableSides()

Gets the sides the mod can be loaded.

Returns:

a Map the key is the side and the value is a Boolean

getDependencies

public ModDependency[] getDependencies()

Gets the mods dependencies.

Returns:

an array of ModDependency

getFormat

public IModFormat getFormat()

Gets the modInfos format.

Returns:

IModFormat

readFromString

public static ModInfo readFromString(String contents)

Reads a string to a manipulation file.

Parameters:

contents - the contents of the manipulator.

See Also:

• IModFormat