Package net.mcreator.plugin

Class PluginInfo

java.lang.Object
net.mcreator.plugin.PluginInfo
public class PluginInfo extends Object

PluginInfo contains all info about the plugin such as its name, its author or a description of it. Most of them are optional.

  • Field Details

  • Constructor Details

    • PluginInfo

      public PluginInfo()

  • Method Details

    • getName

      public String getName()
      Returns:

      The displayed name of the plugin

    • getDescription

      public String getDescription()
      Returns:

      A description displayed in the plugins panel.

    • getAuthor

      public String getAuthor()
      Returns:

      The author(s) of the plugin to be displayed in the plugins panel.

    • getVersion

      public String getVersion()
      This method is used inside the UpdatePluginDialog to check if the user has the latest update of the plugin. See Plugin to read more about this.
      Returns:

      The plugin's version if provided

    • getDependencies

      public List<String> getDependencies()
      See isLoaded in Plugin to get more info about its usage.
      Returns:

      A list of plugin's IDs needed to use the plugin

    • getCredits

      public String getCredits()
      Returns:

      A String with optional credits to give to someone.

    • getUpdateJSONURL

      public String getUpdateJSONURL()

      UpdatePluginDialog uses this method to take an online JSON file containing info about new updates of the plugin. When it detects the version is not equal to the version inside the provided file, MCreator will notify the user.

      Returns:

      A link to an online JSON file

    • getPluginPageID

      public int getPluginPageID()

      When a new update is detected, MCreator will use this number to provide a link to the plugin page of the MCreator website. This number comes after https://mcreator.net/plugin/xxxxx/... The link used will follow this format: https://mcreator.net/node/xxxxx

      Returns:

      The URL number of the plugin page on the MCreator website.