PluginDescriptor
Names and describes your plugin. Put it on your plugin class.
AnnotationRuneLiteRuneLite docs
public @interface PluginDescriptorExample
package com.example.descriptor;
import net.runelite.client.plugins.Plugin;
import net.runelite.client.plugins.PluginDescriptor;
@PluginDescriptor(
name = "Auto Bank",
description = "Opens the nearest bank when your inventory is full",
tags = {"bank", "skilling"}
)
public final class AutoBankPlugin extends Plugin {
}Members
Elements
- Stringdescription()
A short description for the plugin list.
- booleanenabledByDefault()
RuneLite's start state for the plugin.
- Stringname()
The plugin's name in the plugin list. Required.
- String[]tags()
Search words for the plugin list.
description()
String description() default ""A short description for the plugin list.
Returns
The description. Empty when left out.
enabledByDefault()
boolean enabledByDefault() default trueRuneLite's start state for the plugin.
Community plugins ignore it: every plugin starts switched off until the player turns it on.
Returns
Whether RuneLite would start the plugin by itself.
name()
String name()The plugin's name in the plugin list. Required.
Returns
The name.