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

    Interface GridMeasurePathResult

    interface GridMeasurePathResult {
        cost: number;
        diagonals: number;
        distance: number;
        euclidean: number;
        segments: GridMeasurePathResultSegment[];
        spaces: number;
        waypoints: GridMeasurePathResultWaypoint[];
    }
    Index

    Properties

    cost: number

    The total cost of the direct path (foundry.grid.BaseGrid#getDirectPath) through all waypoints.

    diagonals: number

    The total number of diagonals moved along a direct path through all waypoints.

    distance: number

    The total distance travelled along the path through all waypoints.

    euclidean: number

    The total Euclidean length of the straight line path through all waypoints.

    The measurements at each segment.

    spaces: number

    The total number of spaces moved along a direct path through all waypoints. Moving from a grid space to any of its neighbors counts as 1 step. Always 0 in gridless grids.

    The measurements at each waypoint.