Module org.cloudburstmc.api
Package org.cloudburstmc.api.plugin

Interface PluginDescription

public interface PluginDescription

  • Method Details

    • getId

      String getId()
      The ID for this plugin. This should be an alphanumeric name. Slashes are also allowed.
      Returns:
      the ID for this plugin

    • getName

      String getName()

    • getDescription

      Optional<String> getDescription()

    • getPath

      Optional<Path> getPath()
      The path where the plugin is located on the file system.
      Returns:
      the path of this plugin

    • getAuthors

      List<String> getAuthors()
      The author of this plugin.
      Returns:
      the plugin's author

    • getVersion

      String getVersion()
      The version of this plugin.
      Returns:
      the version of this plugin

    • getDependencies

      List<PluginDependency> getDependencies()
      The array of plugin IDs that this plugin requires in order to function fully.
      Returns:
      the dependencies

    • getUrl

      Optional<String> getUrl()
      Plugin's website specified in the plugin.yml.
      Returns:
      website url

    • getPluginLoader

      PluginLoader getPluginLoader()