Interface PathFindStatusRequest

Get the information of the currently-open pathfinding request.

interface PathFindStatusRequest {
    api_version?: number;
    command: "path_find";
    id?: string | number;
    subcommand: "status";
    [x: string]: unknown;
}

Hierarchy

  • BasePathFindRequest
    • PathFindStatusRequest

Indexable

  • [x: string]: unknown

Properties

api_version?: number

The API version to use. If omitted, use version 1.

command: "path_find"

The name of the API method.

id?: string | number

A unique value to identify this request. The response to this request uses the same id field. This way, even if responses arrive out of order, you know which request prompted which response.

subcommand: "status"