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

    Interface TokenPreMovementOperation

    The pre-movement operation data of a token movement. ONLY autoRotate and showRuler are writable.

    interface TokenPreMovementOperation {
        autoRotate: boolean;
        chain: string[];
        constrained: boolean;
        constrainOptions: Omit<
            TokenConstrainMovementPathOptions,
            "preview"
            | "history"
            | "measureOptions",
        >;
        destination: TokenPosition;
        history: TokenMovementHistoryData;
        id: string;
        measureOptions: Omit<TokenMeasureMovementPathOptions, "preview">;
        method: TokenMovementMethod;
        origin: TokenPosition;
        passed: TokenMovementSectionData;
        pending: TokenMovementSectionData;
        recorded: boolean;
        showRuler: boolean;
        terrainOptions: Omit<TokenCreateTerrainMovementPathOptions, "preview">;
    }
    Index

    Properties

    autoRotate chain constrained constrainOptions destination history id measureOptions method origin passed pending recorded showRuler terrainOptions

    Properties

    autoRotate: boolean

    Automatically rotate the token in the direction of movement? This property IS writable.

    chain: string[]

    The chain of prior movement IDs that this movement is a continuation of. This property is NOT writable.

    constrained: boolean

    Was the movement constrained? This property is NOT writable.

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

    The options to constrain movement. This property is NOT writable.

    destination: TokenPosition

    The destination of movement. This property is NOT writable.

    history: TokenMovementHistoryData

    The waypoints and measurements of the history path. This property is NOT writable.

    id: string

    The ID of the movement. This property is NOT writable.

    measureOptions: Omit<TokenMeasureMovementPathOptions, "preview">

    The options to measure movement. This property is NOT writable.

    method: TokenMovementMethod

    The method of movement. This property is NOT writable.

    origin: TokenPosition

    The origin of movement. This property is NOT writable.

    passed: TokenMovementSectionData

    The waypoints and measurements of the passed path. This property is NOT writable.

    pending: TokenMovementSectionData

    The waypoints and measurements of the pending path. This property is NOT writable.

    recorded: boolean

    Was the movement recorded in the movement history? This property is NOT writable.

    showRuler: boolean

    Show the ruler during the movement animation of the token? This property IS writable.

    terrainOptions: Omit<TokenCreateTerrainMovementPathOptions, "preview">

    The terrain movement options. This property is NOT writable.

    Settings

    Member Visibility

    On This Page

    Properties