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

    Interface TokenRegionMovementSegment

    interface TokenRegionMovementSegment {
        action: string;
        from: TokenPosition;
        snapped: boolean;
        terrain: DataModel<object, DataModelConstructionContext> | null;
        to: TokenPosition;
        type: RegionMovementSegmentType;
    }
    Index

    Properties

    action: string

    The movement action between the waypoints.

    The waypoint that this segment starts from.

    snapped: boolean

    Is the destination snapped to the grid?

    terrain: DataModel<object, DataModelConstructionContext> | null

    The terrain data of this segment.

    The waypoint that this segment goes to.

    The type of this segment (see CONST.REGION_MOVEMENT_SEGMENTS).