Foundry Virtual Tabletop - API Documentation - Version 14
    Preparing search index...

    Interface SettingConfig

    A Client Setting

    interface SettingConfig {
        choices?: Object;
        config: boolean;
        default?: any;
        hint: string;
        id?: string;
        input?: CustomFormInput;
        key: string;
        name: string;
        namespace: string;
        onChange?: Function;
        range?: Object;
        scope: "client" | "world" | "user";
        type: BuiltinType | typeof DataModel | DataField;
    }
    Index

    Properties

    choices? config default? hint id? input? key name namespace onChange? range? scope type

    Properties

    choices?: Object

    For string Types, defines the allowable values

    config: boolean

    Indicates if this Setting should render in the Config application

    default?: any

    The default value

    hint: string

    An additional human-readable hint

    id?: string

    The combination of {namespace}.{key}

    input?: CustomFormInput

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

    key: string

    A unique machine-readable id for the setting

    name: string

    The human-readable name

    namespace: string

    The namespace the setting belongs to

    onChange?: Function

    Executes when the value of this Setting changes

    range?: Object

    For numeric Types, defines the allowable range

    scope: "client" | "world" | "user"

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

    type: BuiltinType | typeof DataModel | DataField

    The type of data stored by this Setting

    Settings

    Member Visibility

    On This Page

    Properties