@vttforge/core / SystemSettingOptions

Interface: SystemSettingOptions<T>

Extends

• Omit<SettingConfig<T>, "default">

Type Parameters

T

T

Properties

choices?

readonly optional choices?: Readonly<Record<string, string>>

Inherited from

RegisteredSetting.choices

---

config?

readonly optional config?: boolean

Show it in the settings menu. Leave it off for a schema version.

Inherited from

RegisteredSetting.config

---

default?

optional default?: T

The initial value. Omit it and the accessor's own initializer is used: static accessor homebrew = false registers with default: false.

---

hint?

readonly optional hint?: string

Inherited from

RegisteredSetting.hint

---

key?

optional key?: string

The setting key. Defaults to the accessor's name.

---

name?

readonly optional name?: string

Inherited from

RegisteredSetting.name

---

namespace

namespace: string

The namespace to register under: your system or module id.

---

onChange?

readonly optional onChange?: (value) => void

Parameters

value

T

Returns

void

Inherited from

Omit.onChange

---

range?

readonly optional range?: object

max

readonly max: number

min

readonly min: number

step?

readonly optional step?: number

Inherited from

Omit.range

---

requiresReload?

readonly optional requiresReload?: boolean

Inherited from

RegisteredSetting.requiresReload

---

scope

readonly scope: SettingScope

Inherited from

RegisteredSetting.scope

---

type

readonly type: unknown

Inherited from

RegisteredSetting.type