interface TokenMovementData {
    autoRotate: boolean;
    chain: string[];
    constrained: boolean;
    constrainOptions: Omit<
        TokenConstrainMovementPathOptions,
        "preview"
        | "history",
    >;
    destination: TokenPosition;
    history: TokenMovementHistoryData;
    id: string;
    method: TokenMovementMethod;
    origin: TokenPosition;
    passed: TokenMovementSectionData;
    pending: TokenMovementSectionData;
    recorded: boolean;
    showRuler: boolean;
    state: TokenMovementState;
    updateOptions: object;
    user: documents.User;
}

Properties

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">

The options to constrain movement

destination: TokenPosition

The destination of movement

The waypoints and measurements of the history path

id: string

The ID of the 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?

The state of the movement

updateOptions: object

The update options of the movement operation

The user that moved the token