Interface TokenMovementInstructionOptions

interface TokenMovementInstructionOptions {
    autoRotate?: boolean;
    constrainOptions?: Omit<
        TokenConstrainMovementPathOptions,
        "preview"
        | "history"
        | "measureOptions",
    >;
    id?: string;
    measureOptions?: Omit<TokenMeasureMovementPathOptions, "preview">;
    method?: TokenMovementMethod;
    planned?: boolean;
    showRuler?: boolean;
    split?: boolean;
    terrainOptions?: Omit<TokenCreateTerrainMovementPathOptions, "preview">;
}

Index

Properties

autoRotate? constrainOptions? id? measureOptions? method? planned? showRuler? split? terrainOptions?

Properties

`Optional`autoRotate

autoRotate?: boolean

Automatically rotate the token in the direction of movement? Default: TokenMovementOptions#autoRotate.

`Optional`constrainOptions

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

The options to constrain movement. Default: TokenMovementOptions#constrainOptions.

`Optional`id

id?: string

The movement ID, which must be unique. Default: auto-generated.

`Optional`measureOptions

measureOptions?: Omit<TokenMeasureMovementPathOptions, "preview">

The options to measure movement. Default: TokenMovementOptions#measureOptions.

`Optional`method

method?: TokenMovementMethod

The method of movement. Default: TokenMovementOptions#method.

`Optional`planned

planned?: boolean

Don't start the movement yet? Default: TokenMovementOptions#planned.

`Optional`showRuler

showRuler?: boolean

Show the ruler during the movement animation of the token? Default: TokenMovementOptions#showRuler.

`Optional`split

split?: boolean

Start a new subpath? Default: TokenMovementOptions#split.

`Optional`terrainOptions

terrainOptions?: Omit<TokenCreateTerrainMovementPathOptions, "preview">

The terrain movement options. Default: TokenMovementOptions#terrainOptions.