SoulFire TypeScript SDK 2.10.3
    Preparing search index...

    Interface CollectBlocksTaskOptions

    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 CollectBlocksTaskOptions {
        avoidSubmergedTargets?: boolean;
        call?: CallOptions;
        causationId?: string;
        conflictPolicy?: BotTaskConflictPolicy;
        count?: number;
        deadline?: Date;
        disconnectPolicy?: BotTaskDisconnectPolicy;
        idempotencyKey?: string;
        parentTaskId?: string;
        path?: MessageInit<PathfindOptions>;
        priority?: BotTaskPriority;
        reconnectPolicy?: BotTaskReconnectPolicy;
        requireLineOfSight?: boolean;
        searchRadius?: number;
        tags?: readonly string[];
        targetYRange?: Readonly<{ maximum?: number; minimum?: number }>;
    }

    Hierarchy (View Summary)

    Index
    avoidSubmergedTargets? call? causationId? conflictPolicy? count? deadline? disconnectPolicy? idempotencyKey? parentTaskId? path? priority? reconnectPolicy? requireLineOfSight? searchRadius? tags? targetYRange?
    avoidSubmergedTargets?: boolean

    Skips blocks with fluid above them, up to the bot's height.

    call?: CallOptions
    causationId?: string

    from field: optional string causation_id = 10;

    conflictPolicy?: BotTaskConflictPolicy

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

    count?: number

    Defaults to 1.

    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;

    parentTaskId?: string

    from field: optional string parent_task_id = 9;

    path?: MessageInit<PathfindOptions>
    priority?: BotTaskPriority

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

    reconnectPolicy?: BotTaskReconnectPolicy

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

    requireLineOfSight?: boolean

    Only picks blocks the bot can see, checked again after each block.

    searchRadius?: number

    Defaults to 32, at most 64.

    tags?: readonly string[]

    Block tags to match, besides blockIds.

    targetYRange?: Readonly<{ maximum?: number; minimum?: number }>

    Only blocks between these heights; a missing bound is open.

    Settings
    Member Visibility

    On This Page
    Properties