ConfigItemFields

A value shape that methods take or return.

Methods
None
Fields
15

Fields

FieldTypeDescription
keyNamestringThe store's key.
namestringThe settings page's label.
descriptionstring?The settings page's tooltip, which its filter also searches.
positionnumber?Its place among the section's items, lowest first, then by name; -1 when absent.
sectionstring?The keyName of the ConfigSection it sits in.
typeConfigItemTypeThe value's type: "boolean", "int", "long", "double", "String", Color, Keybind, ModifierlessKeybind, Notification, WorldPoint, Duration, In…
defaultany?The value when nothing is stored.
secretboolean?Only the plugin that declares it reads it; a text item also shows as a password field.
hiddenboolean?Left off the settings page; stored and read like any other item.
warningstring?What the settings page asks the user to confirm before it changes the value; answering no leaves the value unchanged.
alphaboolean?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…
unitsstring?The suffix a number shows: ConfigItem{ ..., units = Units.X }; getUnits() on the item's descriptor reads it back.
methodstring?Another name the proxy answers as this item's getter (showName() for keyName showNpcName): it answers both.
setterstring?Another name the proxy answers as a write. set + the getter's name (setAlignOrbsVertically for alignOrbsVertically) is answered witho…

Field details

type

type: ConfigItemType

The value's type: "boolean", "int", "long", "double", "String", Color, Keybind, ModifierlessKeybind, Notification, WorldPoint, Duration, Instant, Dimension, Point, Rectangle, an enum class, or { set = SomeEnum } (a set of its constants). Also "startStop": a boolean drawn as Start and Stop buttons that never outlives the session (a plugin's run switch); and "loadout": a picker over the loadouts the user saved in the Loadouts plugin, stored as the loadout's name and read by the proxy as that loadout's ConfigLoadout, or nil when none is picked.

range

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 reads them back.

setter

setter: string?

Another name the proxy answers as a write. set + the getter's name (setAlignOrbsVertically for alignOrbsVertically) is answered without it.