Package net.runelite.client.plugins

Annotation Type PluginDescriptor

  • @Retention(RUNTIME)
@Target(TYPE)
@Documented
public @interface PluginDescriptor

    • Required Element Summary

      Required Elements 
      Modifier and Type Required Element Description
      java.lang.String name  

    • Optional Element Summary

      Optional Elements 
      Modifier and Type Optional Element Description
      java.lang.String configName
      Internal name used in the config.
      java.lang.String[] conflicts
      A list of plugin names that are mutually exclusive with this plugin.
      java.lang.String description
      A short, one-line summary of the plugin.
      boolean developerPlugin  
      boolean enabledByDefault
      If this plugin should be defaulted to on.
      boolean hidden
      Whether or not plugin is hidden from configuration panel
      boolean loadInSafeMode  
      boolean loadWhenOutdated
      If this plugin should be loaded when there is no Client
      java.lang.String[] tags
      A list of plugin keywords, used (together with the name) when searching for plugins.

    • Element Detail

      • name

        java.lang.String name

      • configName

        java.lang.String configName
        Internal name used in the config.
        Default:
        ""

      • description

        java.lang.String description
        A short, one-line summary of the plugin.
        Default:
        ""

      • tags

        java.lang.String[] tags
        A list of plugin keywords, used (together with the name) when searching for plugins. Each tag should not contain any spaces, and should be fully lowercase.
        Default:
        {}

      • conflicts

        java.lang.String[] conflicts
        A list of plugin names that are mutually exclusive with this plugin. Any plugins with a name or conflicts value that matches this will be disabled when this plugin is started
        Default:
        {}

      • enabledByDefault

        boolean enabledByDefault
        If this plugin should be defaulted to on. Plugin-Hub plugins should always have this set to true (the default), since having them off by defaults means the user has to install the plugin, then separately enable it, which is confusing.
        Default:
        true

      • hidden

        boolean hidden
        Whether or not plugin is hidden from configuration panel
        Default:
        false

      • developerPlugin

        boolean developerPlugin
        Default:
        false

      • loadWhenOutdated

        boolean loadWhenOutdated
        If this plugin should be loaded when there is no Client
        Default:
        false

      • loadInSafeMode

        boolean loadInSafeMode
        Default:
        true