keyName | string | The store's key. |
|---|
name | string | The settings page's label. |
|---|
description | string? | The settings page's tooltip, which its filter also searches. |
|---|
position | number? | Its place among the section's items, lowest first, then by name; -1 when absent. |
|---|
section | string? | The keyName of the ConfigSection it sits in. |
|---|
type | ConfigItemType | The value's type: "boolean", "int", "long", "double", "String", Color, Keybind, ModifierlessKeybind, Notification, WorldPoint, Duration, In… |
|---|
default | any? | The value when nothing is stored. |
|---|
secret | boolean? | Only the plugin that declares it reads it; a text item also shows as a password field. |
|---|
hidden | boolean? | Left off the settings page; stored and read like any other item. |
|---|
warning | string? | What the settings page asks the user to confirm before it changes the value; answering no leaves the value unchanged. |
|---|
alpha | boolean? | Whether a Color item can set its alpha: ConfigItem{ ..., alpha = true }. |
|---|
range | { min: number?, max: number? }? | A number's bounds: ConfigItem{ ..., range = { min = …, max = … } }, 0 and 2147483647 when left out; getRange() on the item's descriptor… |
|---|
units | string? | The suffix a number shows: ConfigItem{ ..., units = Units.X }; getUnits() on the item's descriptor reads it back. |
|---|
method | string? | Another name the proxy answers as this item's getter (showName() for keyName showNpcName): it answers both. |
|---|
setter | string? | Another name the proxy answers as a write. set + the getter's name (setAlignOrbsVertically for alignOrbsVertically) is answered witho… |
|---|