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

    Interface GridMeasurePathWaypointData3D

    interface GridMeasurePathWaypointData3D {
        cost?: number | GridMeasurePathCostFunction3D<{}>;
        measure?: boolean;
        teleport?: boolean;
    }
    Index

    Properties

    cost?: number | GridMeasurePathCostFunction3D<{}>

    A predetermined cost (nonnegative) or cost function to be used instead of options.cost.

    measure?: boolean

    Measure of the segment from the previous to this waypoint? The distance, cost, spaces, diagonals, and Euclidean length of a segment that is not measured are always 0. Default: true.

    teleport?: boolean

    Teleport to this waypoint? Default: false.