SoulFire TypeScript SDK 2.10.3
    Preparing search index...

    Interface BreedTaskOptions

    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 BreedTaskOptions {
        animals?: MessageInit<EntitySelector>;
        breedingTimeoutTicks?: number;
        call?: CallOptions;
        causationId?: string;
        center?: MessageInit<BlockPosition>;
        completeWhenNoFood?: boolean;
        completeWhenNoPair?: boolean;
        conflictPolicy?: BotTaskConflictPolicy;
        deadline?: Date;
        disconnectPolicy?: BotTaskDisconnectPolicy;
        food?: MessageInit<ItemSelector>;
        idempotencyKey?: string;
        maximumPairs?: number;
        parentTaskId?: string;
        path?: MessageInit<PathfindOptions>;
        priority?: BotTaskPriority;
        radius?: number;
        reconnectPolicy?: BotTaskReconnectPolicy;
        rescanIntervalTicks?: number;
        restoreSelectedSlot?: boolean;
    }

    Hierarchy (View Summary)

    Index
    animals? breedingTimeoutTicks? call? causationId? center? completeWhenNoFood? completeWhenNoPair? conflictPolicy? deadline? disconnectPolicy? food? idempotencyKey? maximumPairs? parentTaskId? path? priority? radius? reconnectPolicy? rescanIntervalTicks? restoreSelectedSlot?
    animals?: MessageInit<EntitySelector>

    Empty (the default) means any animal.

    breedingTimeoutTicks?: number

    Defaults to 100, at most 1200.

    call?: CallOptions
    causationId?: string

    from field: optional string causation_id = 10;

    center?: MessageInit<BlockPosition>
    completeWhenNoFood?: boolean

    Defaults to true for breed, false for runBreed.

    completeWhenNoPair?: boolean

    Defaults to true for breed, false for runBreed.

    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;

    food?: MessageInit<ItemSelector>

    Defaults to any food both animals accept.

    idempotencyKey?: string

    from field: optional string idempotency_key = 11;

    maximumPairs?: number

    0 breeds until cancelled. Defaults to 1 for breed, 0 for runBreed.

    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, from 1 to 64.

    reconnectPolicy?: BotTaskReconnectPolicy

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

    rescanIntervalTicks?: number

    Between scans while no pair is found. Defaults to 100, at most 72000.

    restoreSelectedSlot?: boolean

    Defaults to true.

    Settings
    Member Visibility

    On This Page
    Properties