Interface ModConfigFieldCheckbox

Represents a boolean (true/false) configuration field that will be represented as a checkbox or toggle element in the configuration UI.

Since

D2RMM v1.0.0

interface ModConfigFieldCheckbox {
    defaultValue: boolean;
    description?: string;
    id: string;
    name: string;
    overrideValue?: Binding<null | boolean>;
    type: "checkbox";
    visible?: Binding<boolean>;
}

Hierarchy

  • ModConfigFieldBase
    • ModConfigFieldCheckbox

Properties

defaultValue description? id name overrideValue? type visible?

Properties

defaultValue

defaultValue: boolean

The default value of the checkbox field.

Since

D2RMM v1.0.0

Optional description

description?: string

The description for the field that appears in a help tooltip.

Since

D2RMM v1.0.0

id

id: string

The unique identifier of the configuration element.

name

name: string

The name of the field.

Since

D2RMM v1.0.0

Optional overrideValue

overrideValue?: Binding<null | boolean>

The override value of the checkbox field. If this value is anything other than null, it will override the current value. If the value is overridden, it will also be read only.

Since

D2RMM v1.8.0

type

type: "checkbox"

The type of the configuration element.

Since

D2RMM v1.0.0

Optional visible

visible?: Binding<boolean>

Determines if the field is visible or not.

Since

D2RMM v1.8.0

Settings

Member Visibility

Theme

On This Page

defaultValuedescriptionidnameoverrideValuetypevisible