Interface ModConfigFieldColor

Represents a color configuration field that will be represented as a color picker element in the configuration UI.

Since

D2RMM v1.6.0

interface ModConfigFieldColor {
    defaultValue: NumberArrayBinding<null | number[]>;
    description?: string;
    id: string;
    isAlphaHidden?: boolean;
    name: string;
    overrideValue?: Binding<null | [number, number, number, number]>;
    type: "color";
    visible?: Binding<boolean>;
}

Hierarchy

  • ModConfigFieldBase
    • ModConfigFieldColor

Properties

defaultValue description? id isAlphaHidden? name overrideValue? type visible?

Properties

defaultValue

defaultValue: NumberArrayBinding<null | number[]>

The default value of the color in RGBA format ([0, 255], [0, 255], [0, 255], [0.0, 1.0]). Used when the user has no saved value for this field.

When used as a Binding, it is evaluated once at load time against the saved config — it does NOT re-evaluate reactively at runtime. For reactive value forcing, use overrideValue instead.

Since

D2RMM v1.9.0 as a Binding<>

Since

D2RMM v1.6.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.

Optional isAlphaHidden

isAlphaHidden?: boolean

Whether the alpha channel should be hidden in the color picker.

Since

D2RMM v1.6.0

name

name: string

The name of the field.

Since

D2RMM v1.0.0

Optional overrideValue

overrideValue?: Binding<null | [number, number, number, number]>

The override value of the color 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: "color"

The type of the configuration element.

Since

D2RMM v1.6.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

defaultValuedescriptionidisAlphaHiddennameoverrideValuetypevisible