Pathfinder 1e for Foundry VTT
    Preparing search index...

    Type Alias SidebarField

    type SidebarField = {
        decimals?: number;
        fakeName: boolean;
        fakeValue?: boolean;
        id: string;
        inputValue?: string;
        isBoolean: boolean;
        isNumber: boolean;
        isRange: boolean;
        label: string;
        max?: { name: string; value: string | number };
        name: string;
        value: string | boolean | number | { name: string; value: string | number };
    }
    Index

    Properties

    decimals? fakeName fakeValue? id inputValue? isBoolean isNumber isRange label max? name value

    Properties

    decimals?: number

    Number of decimals to display for numbers

    fakeName: boolean

    Is player lied to about what they're editing. Unused.

    fakeValue?: boolean

    Is SidebarField#inputValue actually used.

    id: string
    inputValue?: string

    Value that will appear in the input field when it is edited, overriding the default value retrieved from the item data using SidebarField#name

    isBoolean: boolean

    Whether the input is a boolean (checkbox)

    isNumber: boolean

    Whether the input is a number (text input)

    isRange: boolean

    Whether this is a dual input for a value and a maximum value

    label: string

    The label for the input

    max?: { name: string; value: string | number }

    Maximum value for a range input

    name: string

    Data path to which the input will be written

    value: string | boolean | number | { name: string; value: string | number }

    The value that is show in the sidebar.

    Ranges require an object with value and name properties.

    Settings

    Member Visibility

    On This Page

    Properties