SoulFire TypeScript SDK 2.10.3
    Preparing search index...

    Interface FarmTaskOptions

    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 FarmTaskOptions {
        call?: CallOptions;
        causationId?: string;
        center?: MessageInit<BlockPosition>;
        completeWhenNoMatureCrops?: boolean;
        conflictPolicy?: BotTaskConflictPolicy;
        cropIds?: readonly string[];
        deadline?: Date;
        disconnectPolicy?: BotTaskDisconnectPolicy;
        idempotencyKey?: string;
        maximumHarvests?: number;
        parentTaskId?: string;
        path?: MessageInit<PathfindOptions>;
        priority?: BotTaskPriority;
        radius?: number;
        reconnectPolicy?: BotTaskReconnectPolicy;
        replant?: boolean;
        rescanIntervalTicks?: number;
        restoreSelectedSlot?: boolean;
    }

    Hierarchy (View Summary)

    Index
    call? causationId? center? completeWhenNoMatureCrops? conflictPolicy? cropIds? deadline? disconnectPolicy? idempotencyKey? maximumHarvests? parentTaskId? path? priority? radius? reconnectPolicy? replant? rescanIntervalTicks? restoreSelectedSlot?
    call?: CallOptions
    causationId?: string

    from field: optional string causation_id = 10;

    center?: MessageInit<BlockPosition>

    Defaults to wherever the bot is at each scan.

    completeWhenNoMatureCrops?: boolean

    Ends instead of waiting for a crop to grow. Defaults to true for farm, false for runFarm.

    conflictPolicy?: BotTaskConflictPolicy

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

    cropIds?: readonly string[]

    Empty (the default) farms every crop SoulFire supports.

    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;

    maximumHarvests?: number

    0 farms until cancelled. Defaults to 1 for farm, 0 for runFarm.

    parentTaskId?: string

    from field: optional string parent_task_id = 9;

    path?: MessageInit<PathfindOptions>
    priority?: BotTaskPriority

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

    radius?: number

    Defaults to 24, at most 48.

    reconnectPolicy?: BotTaskReconnectPolicy

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

    replant?: boolean

    Defaults to true.

    rescanIntervalTicks?: number

    Between scans while nothing is mature. Defaults to 100, at most 72000.

    restoreSelectedSlot?: boolean

    Defaults to true.

    Settings
    Member Visibility

    On This Page
    Properties