hex-world
    Preparing search index...

    Interface ConfigFieldDescriptor

    Describes a single editable field in a generator's config. Keys may use dot notation for nested paths (e.g. "climate.cycles"). Consumers can use this to render controls generically for any plugin.

    interface ConfigFieldDescriptor {
        key: string;
        label: string;
        type: "number" | "boolean" | "select" | "integer";
        default: string | number | boolean;
        min?: number;
        max?: number;
        step?: number;
        options?: { value: string | number; label: string }[];
        group?: string;
    }
    Index

    Properties

    key label type default min? max? step? options? group?

    Properties

    key: string

    Dot-notation path into the config object, e.g. "terrain.period" or "regionCount".

    label: string

    Human-readable label for the control.

    type: "number" | "boolean" | "select" | "integer"

    Control type. 'integer' renders a stepped number input with no decimals.

    default: string | number | boolean

    Runtime default used when the field is absent from the config.

    min?: number
    max?: number
    step?: number
    options?: { value: string | number; label: string }[]

    For 'select' type only.

    group?: string

    Groups related fields together in the UI, e.g. "Terrain", "Climate".

    Settings

    Member Visibility

    On This Page

    Properties