SoulFire TypeScript SDK 2.10.3
    Preparing search index...

    Type Alias FarmTask

    FarmTask: Message<"soulfire.v1.FarmTask"> & {
        center?: BlockPosition;
        completeWhenNoMatureCrops: boolean;
        cropIds: string[];
        maximumHarvests: number;
        options?: PathfindOptions;
        radius: number;
        replant: boolean;
        rescanIntervalTicks: number;
        restoreSelectedSlot: boolean;
    }

    Harvests mature crops in a bounded area and replants crops that require it. An omitted center follows the bot between scans.

    Type Declaration

    • Optionalcenter?: BlockPosition

      from field: optional soulfire.v1.BlockPosition center = 2;

    • completeWhenNoMatureCrops: boolean

      Completes instead of waiting for another crop to mature.

      from field: bool complete_when_no_mature_crops = 6;

    • cropIds: string[]

      Empty selects every crop strategy supported by the server.

      from field: repeated string crop_ids = 1;

    • maximumHarvests: number

      Zero keeps farming until cancellation.

      from field: uint32 maximum_harvests = 4;

    • Optionaloptions?: PathfindOptions

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

    • radius: number

      Zero selects the server default.

      from field: uint32 radius = 3;

    • replant: boolean

      from field: bool replant = 5;

    • rescanIntervalTicks: number

      Delay between scans when no mature crop is available. Zero selects the server default.

      from field: uint32 rescan_interval_ticks = 8;

    • restoreSelectedSlot: boolean

      from field: bool restore_selected_slot = 9;

    from message soulfire.v1.FarmTask

    Settings
    Member Visibility