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

    Interface TokenProcessedMovementWaypoint

    interface TokenProcessedMovementWaypoint {
        action: string;
        checkpoint: boolean;
        depth: number;
        elevation: number;
        explicit: boolean;
        height: number;
        intermediate: boolean;
        level: string;
        shape: TokenShapeType;
        snapped: boolean;
        terrain: DataModel<object, DataModelConstructionContext> | null;
        width: number;
        x: number;
        y: number;
    }
    Index

    Properties

    action: string

    The movement action from the previous to this waypoint. Default: the prepared movement action.

    checkpoint: boolean

    Is this waypoint a checkpoint? There's an update/movement operation for each checkpoint in a movement path. At a checkpoint the movement can be stopped or paused. Default: false.

    depth: number

    The depth in grid spaces (nonnegative). Default: the previous or source depth.

    elevation: number

    The elevation in grid units. Default: the previous or source elevation.

    explicit: boolean

    Was this waypoint explicitly placed by the user? Default: false.

    height: number

    The height in grid spaces (positive). Default: the previous or source height.

    intermediate: boolean

    Is this waypoint intermediate? Default: false.

    level: string

    The level ID. Default: the previous or source level ID.

    The shape type (see CONST.TOKEN_SHAPES). Default: the previous or source shape.

    snapped: boolean

    Was this waypoint snapped to the grid? Default: false.

    terrain: DataModel<object, DataModelConstructionContext> | null

    The terrain data of this segment. Default: null.

    width: number

    The width in grid spaces (positive). Default: the previous or source width.

    x: number

    The top-left x-coordinate in pixels (integer). Default: the previous or source x-coordinate.

    y: number

    The top-left y-coordinate in pixels (integer). Default: the previous or source y-coordinate.