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

    Interface GridMeasurePathResultWaypoint

    interface GridMeasurePathResultWaypoint {
        backward: GridMeasurePathResultSegment | null;
        cost: number;
        diagonals: number;
        distance: number;
        euclidean: number;
        forward: GridMeasurePathResultSegment | null;
        spaces: number;
    }
    Index

    Properties

    The segment from the previous waypoint to this waypoint.

    cost: number

    The total cost of the direct path (foundry.grid.BaseGrid#getDirectPath) up to this waypoint.

    diagonals: number

    The total number of diagonals moved along a direct path up to this waypoint.

    distance: number

    The total distance travelled along the path up to this waypoint.

    euclidean: number

    The total Euclidean length of the straight line path up to this waypoint.

    The segment from this waypoint to the next waypoint.

    spaces: number

    The total number of spaces moved along a direct path up to this waypoint.