SoulFire TypeScript SDK 2.10.3
    Preparing search index...

    Type Alias CollectBlocksTask

    CollectBlocksTask: Message<"soulfire.v1.CollectBlocksTask"> & {
        avoidSubmergedTargets: boolean;
        blockIds: string[];
        count: number;
        options?: PathfindOptions;
        requireLineOfSight: boolean;
        searchRadius: number;
        tags: string[];
        targetYRange?: IntRange;
    }

    Core task input for finding and mining matching blocks.

    Type Declaration

    • avoidSubmergedTargets: boolean

      Excludes targets with fluid above them up to the bot's current elevation. Useful when a caller cannot safely manage underwater collection.

      from field: bool avoid_submerged_targets = 6;

    • blockIds: string[]

      from field: repeated string block_ids = 1;

    • count: number

      Zero selects one block.

      from field: uint32 count = 3;

    • Optionaloptions?: PathfindOptions

      from field: soulfire.v1.PathfindOptions options = 5;

    • requireLineOfSight: boolean

      Only selects targets that the bot can currently see. Visibility is reevaluated after every collected block, allowing newly exposed targets to become eligible without routing toward hidden blocks.

      from field: bool require_line_of_sight = 7;

    • searchRadius: number

      Zero selects the server default.

      from field: uint32 search_radius = 4;

    • tags: string[]

      from field: repeated string tags = 2;

    • OptionaltargetYRange?: IntRange

      Restricts candidate block elevations. An omitted bound is unbounded.

      from field: soulfire.v1.IntRange target_y_range = 8;

    from message soulfire.v1.CollectBlocksTask