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

    Interface TokenFindMovementPathJob

    interface TokenFindMovementPathJob {
        cancel: () => void;
        promise: Promise<TokenMovementWaypoint[] | null>;
        result: TokenMovementWaypoint[] | null | undefined;
    }
    Index

    Properties

    Properties

    cancel: () => void

    If this function is called and the job hasn't completed yet, the job is cancelled.

    promise: Promise<TokenMovementWaypoint[] | null>

    The promise returning the (partial) path that as found or null if cancelled.

    result: TokenMovementWaypoint[] | null | undefined

    The result of the pathfinding job. Undefined while the search is in progress, null if the job was cancelled, and the (partial) path if the job completed.