The default implementation of the Token ruler.

Hierarchy (View Summary)

Properties

WAYPOINT_LABEL_TEMPLATE: string = "templates/hud/waypoint-label.hbs"

A handlebars template used to render each waypoint label.

Accessors

Methods

  • Parameters

    • __namedParameters: { passedWaypoints: any; pendingWaypoints: any; plannedMovement: any }

    Returns void

  • Protected

    Configure the properties of the dash line. Called in TokenRuler#draw.

    Returns { dash: number; gap: number; speed: number }

    The dash in pixels, the gap in pixels, and the speed in pixels per second

  • Protected

    Configure the properties of the outline. Called in TokenRuler#draw.

    Returns { color: ColorSource; thickness: number }

    The thickness in pixels and the color

  • Protected

    Get the style to be used to highlight the grid offset.

    Parameters

    Returns {
        alpha?: number;
        color?: ColorSource;
        matrix?: null | Matrix;
        texture?: Texture<Resource>;
    }

    The color, alpha, texture, and texture matrix to be used to draw the grid space. If the alpha is 0, the grid space is not highlighted.

  • Protected

    Get the style of the segment from the previous to the given waypoint.

    Parameters

    Returns { alpha?: number; color?: ColorSource; width: number }

    The line width, color, and alpha of the segment. If the width is 0, no segment is drawn.

  • Protected

    Get the style of the waypoint at the given waypoint.

    Parameters

    Returns { alpha?: number; color?: ColorSource; radius: number }

    The radius, color, and alpha of the waypoint. If the radius is 0, no waypoint marker is drawn.