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

    Interface RegionTemplateModeConfig

    interface RegionTemplateModeConfig {
        color?: string;
        coneAngle: number;
        coneCurvature: "flat" | "round" | "semicircle";
        displayMeasurements?: boolean;
        flags?: DocumentFlags;
        gridBased: boolean;
        highlightMode?: "shapes" | "coverage";
        restriction?: RegionRestrictionData;
        ringAlignment: number;
        shapeTypes: string[];
        visibility?: number;
    }
    Index

    Properties

    color? coneAngle coneCurvature displayMeasurements? flags? gridBased highlightMode? restriction? ringAlignment shapeTypes visibility?

    Properties

    color?: string

    The color used to highlight the Region. The user's color by default.

    coneAngle: number

    The cone angle.

    coneCurvature: "flat" | "round" | "semicircle"

    The cone curvature.

    displayMeasurements?: boolean

    Are measurements displayed for the Region?

    flags?: DocumentFlags

    An object of optional key/value flags.

    gridBased: boolean

    Whether the shapes are grid-based.

    highlightMode?: "shapes" | "coverage"

    Whether the true shapes of the Region or the grid spaces that it covers are highlighted.

    restriction?: RegionRestrictionData

    The configuration of the constraint that walls impose on the shapes of the Region.

    ringAlignment: number

    The alignment of the ring, a number between 0 and 1.

    shapeTypes: string[]

    The types of shapes that are available.

    visibility?: number

    The visibility of the Region, from CONST.REGION_VISIBILITY.

    Settings

    Member Visibility

    On This Page

    Properties