polymod.ModMetadata - Leather Engine Documentation

A type representing data about a mod, as retrieved from its metadata file.

Static methods

`staticfromJsonStr(str:String):Null<ModMetadata>`

Constructor

`new()`

Variables

`apiVersion:Version`

A version number for the API used by the mod. Used to prevent compatibility issues with mods when the application changes.

`author:String`

Deprecated:

A deprecated field representing the mod's author. Please use the contributors field instead.

`contributors:Array<ModContributor>`

A list of contributors to the mod. Provides data about their roles as well as optional contact information.

`dependencies:ModDependencies`

A list of dependencies. These other mods must be also be loaded in order for this mod to load, and this mod must be loaded after the dependencies.

`description:String`

A short description of the mod.

`homepage:String`

A link to the homepage for a mod. Should provide a URL where the mod can be downloaded from.

`@:value(null)icon:Bytes = null`

Binary data containing information on the mod's icon file, if it exists. This is useful when you want to display the mod's icon in your application's mod menu.

`iconPath:String`

The path on the filesystem to the mod's icon file.

`id:String`

The internal ID of the mod.

`license:String`

The name of a license determining the terms of use for the mod.

`metadata:Map<String, String>`

metadata provides an optional list of keys. These can provide additional information about the mod, specific to your application.

`modPath:String`

The path where this mod's files are stored, on the IFileSystem.

`modVersion:Version`

A version number for the mod itself. Should be provided in the Semantic Versioning format.

`optionalDependencies:ModDependencies`

A list of dependencies. This mod must be loaded after the optional dependencies, but those mods do not necessarily need to be loaded.

`title:String`

The human-readable name of the mod.

class ModMetadata

package polymod

import polymod.Polymod