Interface TokenConstrainMovementPathOptions

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

Index

Properties

history? ignoreCost? ignoreWalls? measureOptions? preview?

Properties

`Optional`history

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.

`Optional`ignoreCost

ignoreCost?: boolean

Ignore cost? Default: false.

`Optional`ignoreWalls

ignoreWalls?: boolean

Ignore walls and surfaces? Default: false.

`Optional`measureOptions

measureOptions?: Omit<TokenMeasureMovementPathOptions, "preview">

The measurement options.

`Optional`preview

preview?: boolean

Constrain a preview path? Default: false.