interface SettingConfig {
    key: string;
    namespace: string;
    name: string;
    hint: string;
    scope: string;
    config: boolean;
    type: any;
    choices: Object;
    range: Object;
    default: any;
    onChange: Function;
    input: CustomFormInput;
}

Properties

key: string

A unique machine-readable id for the setting

namespace: string

The namespace the setting belongs to

name: string

The human-readable name

hint: string

An additional human-readable hint

scope: string

The scope the Setting is stored in, either World or Client

config: boolean

Indicates if this Setting should render in the Config application

type: any

The type of data stored by this Setting

choices: Object

For string Types, defines the allowable values

range: Object

For numeric Types, defines the allowable range

default: any

The default value

onChange: Function

Executes when the value of this Setting changes

input: CustomFormInput

A custom form field input used in conjunction with a DataField type