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

    Interface HexagonalGridConfiguration

    interface HexagonalGridConfiguration {
        alpha?: number;
        color?: ColorSource;
        columns?: boolean;
        diagonals?: GridDiagonalRule;
        distance?: number;
        even?: boolean;
        size: number;
        style?: string;
        thickness?: number;
        units?: string;
    }
    Index

    Properties

    alpha? color? columns? diagonals? distance? even? size style? thickness? units?

    Properties

    alpha?: number

    The alpha of the grid. Default: 1.

    color?: ColorSource

    The color of the grid. Default: 0x000000.

    columns?: boolean

    Is this grid column-based (flat-topped) or row-based (pointy-topped)? Default: false.

    diagonals?: GridDiagonalRule

    The rule for diagonal measurement (see CONST.GRID_DIAGONALS). Default: CONST.GRID_DIAGONALS.EQUIDISTANT.

    distance?: number

    The distance of a grid space in units (a positive number). Default: 1.

    even?: boolean

    Is this grid even or odd? Default: false.

    size: number

    The size of a grid space in pixels (a positive number).

    style?: string

    The style of the grid. Default: "solidLines".

    thickness?: number

    The line thickness of the grid. Default: 1.

    units?: string

    The units of measurement. Default: "".

    Settings

    Member Visibility

    On This Page

    Properties