Interface TokenFindMovementPathOptions

interface TokenFindMovementPathOptions {
    constrainOptions?: Omit<
        TokenConstrainMovementPathOptions,
        "preview"
        | "measureOptions",
    >;
    delay?: number;
    measureOptions?: Omit<TokenMeasureMovementPathOptions, "preview">;
    preview?: boolean;
    terrainOptions?: Omit<TokenCreateTerrainMovementPathOptions, "preview">;
}

Index

Properties

constrainOptions? delay? measureOptions? preview? terrainOptions?

Properties

`Optional`constrainOptions

constrainOptions?: Omit<
    TokenConstrainMovementPathOptions,
    "preview"
    | "measureOptions",
>

The constrain options.

`Optional`delay

delay?: number

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

`Optional`measureOptions

measureOptions?: Omit<TokenMeasureMovementPathOptions, "preview">

The measure options.

`Optional`preview

preview?: boolean

Find a preview path? Default: false.

`Optional`terrainOptions

terrainOptions?: Omit<TokenCreateTerrainMovementPathOptions, "preview">

The terrain options.