ConfigItem

Intermediate

net.runelite.client.config

Annotation for individual configuration items. Use this to define specific settings in your config interface.

Category
Configuration
Methods
0
Properties
4

Properties (4)

keyName

String

Unique identifier for the config item (required)

java
1@ConfigItem(
2    keyName = "enabled",  // This is the keyName
3    name = "Enable Plugin",
4    description = "Turn the plugin on or off"
5)
6default boolean enabled() {
7    return true;
8}

name

String

Display name shown in the config panel (required)

java
1@ConfigItem(
2    keyName = "enabled",
3    name = "Enable Plugin",  // This is what users see
4    description = "Turn the plugin on or off"
5)

description

String

Help text explaining what the setting does (required)

java
1@ConfigItem(
2    keyName = "enabled",
3    name = "Enable Plugin",
4    description = "Turn the plugin on or off"  // Help text
5)

section

String

Optional section name to group related settings

java
1@ConfigItem(
2    keyName = "showText",
3    name = "Show Text",
4    description = "Display text",
5    section = displaySection  // Group in a section
6)

Related Classes

ConfigConfigGroupConfigSection

Plugins Using This Class

all-plugins