Interface GridMeasurePathResultSegment

A segment of foundry.grid.types.GridMeasurePathResult.

interface GridMeasurePathResultSegment {
    cost: number;
    diagonals: number;
    distance: number;
    euclidean: number;
    from: GridMeasurePathResultWaypoint;
    spaces: number;
    to: GridMeasurePathResultWaypoint;
}

Index

Properties

cost diagonals distance euclidean from spaces to

Properties

cost

cost: number

The cost of the direct path (foundry.grid.BaseGrid#getDirectPath) between the two waypoints.

diagonals

diagonals: number

The number of diagonals moved along this segment.

distance

distance: number

The distance travelled in grid units along this segment.

euclidean

euclidean: number

The Euclidean length of the straight line segment between the two waypoints.

from

from: GridMeasurePathResultWaypoint

The waypoint that this segment starts from.

spaces

spaces: number

The number of spaces moved along this segment.

to

to: GridMeasurePathResultWaypoint

The waypoint that this segment goes to.