net.runelite.client.plugins

Annotation Type PluginDescriptor

@Retention(value=RUNTIME)
 @Target(value=TYPE)
 @Documented
public @interface PluginDescriptor

Required Element Summary

Required Elements

Modifier and Type	Required Element and Description
String	name

Optional Element Summary

Optional Elements

Modifier and Type	Optional Element and Description
String	description A short, one-line summary of the plugin.
boolean	developerPlugin
boolean	enabledByDefault
boolean	hidden Whether or not plugin is hidden from configuration panel
boolean	loadWhenOutdated
String[]	tags A list of plugin keywords, used (together with the name) when searching for plugins.

Element Detail

name

public abstract String name

description

public abstract String description

A short, one-line summary of the plugin.

Default:

""

tags

public abstract 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:

{}

enabledByDefault

public abstract boolean enabledByDefault

Default:

true

hidden

public abstract boolean hidden

Whether or not plugin is hidden from configuration panel

Default:

false

developerPlugin

public abstract boolean developerPlugin

Default:

false

loadWhenOutdated

public abstract boolean loadWhenOutdated

Default:

false