[Go to site: main page, start]

Interface TokenMovementData

The token movement data that describes the current/last movement of the token. NONE of the properties are writable.

interface TokenMovementData {
    animation: {
        duration: number;
        ended: Promise<void>;
        started: Promise<void>;
    };
    autoRotate: boolean;
    chain: string[];
    constrained: boolean;
    constrainOptions: Omit<
        TokenConstrainMovementPathOptions,
        "preview"
        | "history"
        | "measureOptions",
    >;
    destination: TokenPosition;
    finished: Promise<boolean>;
    history: TokenMovementHistoryData;
    id: string;
    measureOptions: Omit<TokenMeasureMovementPathOptions, "preview">;
    method: TokenMovementMethod;
    origin: TokenPosition;
    passed: TokenMovementSectionData;
    pending: TokenMovementSectionData;
    recorded: boolean;
    showRuler: boolean;
    split: boolean;
    state: TokenMovementState;
    subpathId: string;
    terrainOptions: Omit<TokenCreateTerrainMovementPathOptions, "preview">;
    updateOptions: object;
    user: documents.User;
}
Index

Properties

animation: { duration: number; ended: Promise<void>; started: Promise<void> }

The promise that resolves when the animation of this movement starts, the promise that resolves when the animation of this movement ends, and the duration of the animation of this movement.

autoRotate: boolean

Automatically rotate the token in the direction of movement?

chain: string[]

The chain of prior movement IDs that this movement is a continuation of

constrained: boolean

Was the movement constrained?

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

The options to constrain movement

destination: TokenPosition

The destination of movement

finished: Promise<boolean>

The promise that resolves once the entire movement is finished. It resolves to true if the movement completed, otherwise false.

The waypoints and measurements of the history path

id: string

The ID of the movement

measureOptions: Omit<TokenMeasureMovementPathOptions, "preview">

The options to measure movement

The method of movement

The origin of movement

The waypoints and measurements of the passed path

The waypoints and measurements of the pending path

recorded: boolean

Was the movement recorded in the movement history?

showRuler: boolean

Show the ruler during the movement animation of the token?

split: boolean

Was a new subpath started?

The state of the movement

subpathId: string

The ID of the subpath, which is equal to the movement ID of the first waypoint in the subpath

terrainOptions: Omit<TokenCreateTerrainMovementPathOptions, "preview">

The terrain movement options

updateOptions: object

The update options of the movement operation

The user that moved the token