interface TokenRulerWaypointData {
    actionConfig: TokenMovementActionConfig;
    center: Point;
    hidden: boolean;
    index: number;
    measurement: GridMeasurePathResultWaypoint;
    movementId: null | string;
    next: null | TokenRulerWaypoint;
    previous: null | TokenRulerWaypoint;
    ray: null | Ray;
    size: { height: number; width: number };
    stage: "passed" | "pending" | "planned";
    unreachable: boolean;
}

Properties

The config of the movement action

center: Point

The center point of the Token at this waypoint.

hidden: boolean

Is this waypoint hidden?

index: number

The index of the waypoint, which is equal to the number of explicit waypoints from the first to this waypoint.

The measurements at this waypoint.

movementId: null | string

The ID of movement, or null if planned movement.

next: null | TokenRulerWaypoint

The next waypoint, if any.

previous: null | TokenRulerWaypoint

The previous waypoint, if any.

ray: null | Ray

The ray from the center point of previous to the center point of this waypoint, or null if there is no previous waypoint.

size: { height: number; width: number }

The size of the Token in pixels at this waypoint.

stage: "passed" | "pending" | "planned"

The stage this waypoint belongs to.

unreachable: boolean

Is this waypoint unreachable?