Interface ConfigField

All Known Implementing Classes:

ConfigField.BoolField, ConfigField.ChoiceField, ConfigField.IntField, ConfigField.ItemIdField, ConfigField.StringField

public sealed interface ConfigField
permits ConfigField.IntField, ConfigField.StringField, ConfigField.BoolField, ConfigField.ChoiceField, ConfigField.ItemIdField

Describes a single configurable parameter that a script exposes. Scripts return a list of these from BotScript.getConfigFields().

A ConfigField is a sealed hierarchy of typed variants. Scripts construct them through the static factory methods (intField(String, String, int), stringField(String, String, String), boolField(String, String, boolean), choiceField(String, String, List, String), itemIdField(String, String, int)); consumers dispatch over the variants with an exhaustive switch pattern match.

Nested Class Summary

Nested Classes

Modifier and Type	Interface	Description
static final record	ConfigField.BoolField	A boolean-valued field rendered as a checkbox.
static final record	ConfigField.ChoiceField	A field whose value is one of an enumerated set of choices.
static final record	ConfigField.IntField	An integer-valued field.
static final record	ConfigField.ItemIdField	An integer-valued field representing an item id.
static final record	ConfigField.StringField	A free-text string-valued field.

Method Summary

Modifier and Type	Method	Description
static ConfigField	boolField(String key, String label, boolean defaultValue)
static ConfigField	choiceField(String key, String label, List<String> choices, String defaultValue)
default String	defaultAsString()
static ConfigField	intField(String key, String label, int defaultValue)
static ConfigField	itemIdField(String key, String label, int defaultValue)
String	key()
String	label()
static ConfigField	stringField(String key, String label, String defaultValue)

Method Details

key

String key()

Returns:

the configuration key (used for lookup in ScriptConfig)

label

String label()

Returns:

the human-readable label shown in UIs

defaultAsString

default String defaultAsString()

Returns:

the string form of this field's default value, in the same format the persistence layer stores on disk.

intField

static ConfigField intField(String key,
 String label,
 int defaultValue)

stringField

static ConfigField stringField(String key,
 String label,
 String defaultValue)

boolField

static ConfigField boolField(String key,
 String label,
 boolean defaultValue)

choiceField

static ConfigField choiceField(String key,
 String label,
 List<String> choices,
 String defaultValue)

itemIdField

static ConfigField itemIdField(String key,
 String label,
 int defaultValue)