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

    Interface _TokenFindMovementPathOptions

    interface _TokenFindMovementPathOptions {
        delay?: number;
        measureOptions?: Omit<TokenMeasureMovementPathOptions, "preview">;
        preview?: boolean;
        terrainOptions?: Omit<TokenCreateTerrainMovementPathOptions, "preview">;
    }
    Index

    Properties

    delay?: number

    Unless the path can be found instantly, delay the start of the pathfinding computation by this number of milliseconds. Default: 0.

    measureOptions?: Omit<TokenMeasureMovementPathOptions, "preview">

    The measure options.

    preview?: boolean

    Find a preview path? Default: false.

    terrainOptions?: Omit<TokenCreateTerrainMovementPathOptions, "preview">

    The terrain options.