[Go to site: main page, start]

Interface _TokenRulerWaypoint

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

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: string | null

The ID of movement, or null if planned movement.

next: TokenRulerWaypoint | null

The next waypoint, if any.

previous: TokenRulerWaypoint | null

The previous waypoint, if any.

ray: Ray | null

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: "planned" | "pending" | "passed"

The stage this waypoint belongs to.

subpathId: string | null

The ID of subpath, which is equal to the movement ID of the first waypoint in the subpath, or null if planned movement.

unreachable: boolean

Is this waypoint unreachable?