@vttforge/types / SettingConfig

Interface: SettingConfig<T>

Type Parameters

T

T = unknown

Properties

choices?

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

---

config?

readonly optional config?: boolean

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

---

default

readonly default: T

---

hint?

readonly optional hint?: string

---

name?

readonly optional name?: string

---

onChange?

readonly optional onChange?: (value) => void

Parameters

value

T

Returns

void

---

range?

readonly optional range?: object

max

readonly max: number

min

readonly min: number

step?

readonly optional step?: number

---

requiresReload?

readonly optional requiresReload?: boolean

---

scope

readonly scope: SettingScope

---

type

readonly type: unknown