SoulFire TypeScript SDK 2.10.3
    Preparing search index...

    Interface ExploreTaskOptions

    Scheduling, ownership, and request options for a durable bot task.

    Unspecified policies use server defaults. RPC timeouts and task deadlines control different stages. Reuse an idempotency key when retrying a submission.

    interface ExploreTaskOptions {
        call?: CallOptions;
        causationId?: string;
        conflictPolicy?: BotTaskConflictPolicy;
        deadline?: Date;
        disconnectPolicy?: BotTaskDisconnectPolicy;
        idempotencyKey?: string;
        maximumWaypoints?: number;
        origin?: MessageInit<BlockPosition>;
        parentTaskId?: string;
        path?: MessageInit<PathfindOptions>;
        priority?: BotTaskPriority;
        purpose?: string;
        radius?: number;
        reconnectPolicy?: BotTaskReconnectPolicy;
        returnToOrigin?: boolean;
        waypointSpacing?: number;
    }

    Hierarchy (View Summary)

    Index
    call? causationId? conflictPolicy? deadline? disconnectPolicy? idempotencyKey? maximumWaypoints? origin? parentTaskId? path? priority? purpose? radius? reconnectPolicy? returnToOrigin? waypointSpacing?
    call?: CallOptions
    causationId?: string

    from field: optional string causation_id = 10;

    conflictPolicy?: BotTaskConflictPolicy

    from field: soulfire.v1.BotTaskConflictPolicy conflict_policy = 4;

    deadline?: Date

    The task ends as TIMED_OUT at this time. Must be in the future.

    disconnectPolicy?: BotTaskDisconnectPolicy

    from field: soulfire.v1.BotTaskDisconnectPolicy disconnect_policy = 6;

    idempotencyKey?: string

    from field: optional string idempotency_key = 11;

    maximumWaypoints?: number

    0 explores until every cell is visited or the task is cancelled. Defaults to 1 for explore, 0 for runExplore.

    origin?: MessageInit<BlockPosition>

    Defaults to where the bot is when the task starts.

    parentTaskId?: string

    from field: optional string parent_task_id = 9;

    path?: MessageInit<PathfindOptions>
    priority?: BotTaskPriority

    from field: soulfire.v1.BotTaskPriority priority = 7;

    purpose?: string

    Bots with the same purpose share out the cells. Defaults to "sdk-explore".

    radius?: number

    Horizontal distance from origin. Defaults to 256, from 1 to 4096.

    reconnectPolicy?: BotTaskReconnectPolicy

    from field: soulfire.v1.BotTaskReconnectPolicy reconnect_policy = 5;

    returnToOrigin?: boolean

    Goes back to origin after maximumWaypoints.

    waypointSpacing?: number

    Defaults to 64, from 8 to 512.

    Settings
    Member Visibility

    On This Page
    Properties