StringSetting

A free-text setting.

Remarks

Can only be created while initializing the script.

Example

const message = new StringSetting("Message", "The text to send.", "gg", 100);

Extends

• Setting

Constructors

Constructor

new StringSetting(owner, name, description, defaultValue): StringSetting

Parameters

owner

object

Can either be 'script' or a subgroup.

name

string

The name of the setting.

description

string

The description of the setting.

defaultValue

string

The default value of the setting.

Returns

StringSetting

Overrides

Setting.constructor

Constructor

new StringSetting(owner, name, description, defaultValue, maxLength): StringSetting

Parameters

owner

object

Can either be 'script' or a subgroup.

name

string

The name of the setting.

description

string

The description of the setting.

defaultValue

string

The default value of the setting.

maxLength

number

The most characters the setting will accept.

Returns

StringSetting

Overrides

Setting.constructor

Methods

description()

description(): string

Returns

string

The description of the setting.

Inherited from

Setting.description

---

getValue()

getValue(): string

Returns

string

The value of the setting.

---

name()

name(): string

Returns

string

The name of the setting.

Inherited from

Setting.name

---

setValue()

setValue(value): void

Parameters

value

string

The value to set the setting to.

Returns

void

---

visible()

visible(visible): void

You can use this to hide settings temporarily depending on the user config. The callback should return a boolean.

Parameters

visible

Function

The function to determine if the setting should be visible or not.

Returns

void

Example

const delay = new IntSetting("Delay", "The amount of ticks to wait in between attacks.", false);

delay.visible(() => {
	return someOtherSetting.getValue()
});

Inherited from

Setting.visible