SoulFire TypeScript SDK 2.10.3
    Preparing search index...

    Interface RangedAttackTaskOptions

    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 RangedAttackTaskOptions {
        bowDrawTicks?: number;
        call?: CallOptions;
        causationId?: string;
        compensateGravity?: boolean;
        conflictPolicy?: BotTaskConflictPolicy;
        deadline?: Date;
        disconnectPolicy?: BotTaskDisconnectPolicy;
        idempotencyKey?: string;
        leadTarget?: boolean;
        maximumRange?: number;
        maximumShots?: number;
        minimumRange?: number;
        parentTaskId?: string;
        path?: MessageInit<PathfindOptions>;
        priority?: BotTaskPriority;
        reconnectPolicy?: BotTaskReconnectPolicy;
        restoreSelectedSlot?: boolean;
        strafe?: boolean;
        targetUnavailableTimeoutSeconds?: number;
        weapon?: MessageInit<ItemSelector>;
    }

    Hierarchy (View Summary)

    Index
    bowDrawTicks? call? causationId? compensateGravity? conflictPolicy? deadline? disconnectPolicy? idempotencyKey? leadTarget? maximumRange? maximumShots? minimumRange? parentTaskId? path? priority? reconnectPolicy? restoreSelectedSlot? strafe? targetUnavailableTimeoutSeconds? weapon?
    bowDrawTicks?: number

    Defaults to 20, from 3 to 20. Crossbows use their own charge time.

    call?: CallOptions
    causationId?: string

    from field: optional string causation_id = 10;

    compensateGravity?: boolean

    Defaults to true.

    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;

    idempotencyKey?: string

    from field: optional string idempotency_key = 11;

    leadTarget?: boolean

    Defaults to true.

    maximumRange?: number

    Defaults to 24, at most 64.

    maximumShots?: number

    0 (the default) fires until the target is defeated.

    minimumRange?: number

    Defaults to 8; less than maximumRange.

    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;

    restoreSelectedSlot?: boolean

    Defaults to true.

    strafe?: boolean

    Defaults to true.

    targetUnavailableTimeoutSeconds?: number

    How long the target may stay out of sight before the task ends. Defaults to 10, at most 3600.

    weapon?: MessageInit<ItemSelector>

    Limits which bow or crossbow may be picked.

    Settings
    Member Visibility

    On This Page
    Properties