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

    Interface TokenConstrainMovementPathOptions

    interface TokenConstrainMovementPathOptions {
        history?:
            | boolean
            | readonly DeepReadonly<TokenMeasuredMovementWaypoint>[];
        ignoreCost?: boolean;
        ignoreWalls?: boolean;
        maxCost?: number;
        maxDistance?: number;
        measureOptions?: Omit<TokenMeasureMovementPathOptions, "preview">;
        preview?: boolean;
    }
    Index

    Properties

    history? ignoreCost? ignoreWalls? maxCost? maxDistance? measureOptions? preview?

    Properties

    history?: boolean | readonly DeepReadonly<TokenMeasuredMovementWaypoint>[]

    Consider movement history? If true, uses the current movement history. If waypoints are passed, use those as the history. Default: false.

    ignoreCost?: boolean

    Ignore cost? Default: false.

    ignoreWalls?: boolean

    Ignore walls and surfaces? Default: false.

    maxCost?: number

    The maximum cumulative cost.

    maxDistance?: number

    The maximum cumulative distance.

    measureOptions?: Omit<TokenMeasureMovementPathOptions, "preview">

    The measurement options.

    preview?: boolean

    Constrain a preview path? Default: false.

    Settings

    Member Visibility

    On This Page

    Properties