Package net.minheur.potoflux.loader.mod

Annotation Interface Mod

@Retention(RUNTIME) @Target(TYPE) public @interface Mod
The class to annotate your main mod class with.
This contains all main data for the mod (that doesn't need to create the mod to be accessed).

  • Required Element Summary

    Required Elements
    Modifier and Type
    Required Element
    Description
    String
    modId
    The mod ID of your mod.
    String
    version
    The version of your mod.

  • Optional Element Summary

    Optional Elements
    Modifier and Type
    Optional Element
    Description
    String[]
    compatibleVersions
    The list of all potoflux versions your mod is compatible with.
    Should take the form of compatibleVersions = {"6.0", "6.1"}
    String
    compatibleVersionUrl
    An online URL, leading to a JSON file.
    The file must contain a JSON object.
    The object must contain 1 entry by version :
    The key of the entry is the version (same as set in version()),
    and the content an array of strings.
    String[]
    dependenciesIds
    A list of dependencies mods.
    Each entry needs to be formated like id:minVersion:maxVersion or id:version
    String[]
    externalDependencies
     

  • Element Details

    • modId

      String modId
      The mod ID of your mod. Should be a unique identifier for your mod.
      Returns:
      your mod's ID

    • version

      String version
      The version of your mod.
      Returns:
      your mod's version

    • compatibleVersions

      String[] compatibleVersions
      The list of all potoflux versions your mod is compatible with.
      Should take the form of compatibleVersions = {"6.0", "6.1"}
      Returns:
      potoflux versions compatible with your mod
      Default:
      {"-1"}

    • compatibleVersionUrl

      String compatibleVersionUrl
      An online URL, leading to a JSON file.
      The file must contain a JSON object.
      The object must contain 1 entry by version :
      The key of the entry is the version (same as set in version()),
      and the content an array of strings. Each string of the array is one potoflux version supported by the corresponding mod version
      Returns:
      the online compatible version URL
      Default:
      "NONE"

    • dependenciesIds

      String[] dependenciesIds
      A list of dependencies mods.
      Each entry needs to be formated like id:minVersion:maxVersion or id:version
      Returns:
      an array of dependencies mods
      Default:
      {}

    • externalDependencies

      String[] externalDependencies
      Default:
      {}