SoulFire TypeScript SDK 2.10.3
    Preparing search index...

    Interface AttackNearestTaskOptions

    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 AttackNearestTaskOptions {
        attackRange?: number;
        call?: CallOptions;
        causationId?: string;
        completeWhenNoTarget?: boolean;
        conflictPolicy?: BotTaskConflictPolicy;
        deadline?: Date;
        disconnectPolicy?: BotTaskDisconnectPolicy;
        idempotencyKey?: string;
        maximumAttacks?: number;
        maximumTargets?: number;
        noTargetTimeoutSeconds?: number;
        parentTaskId?: string;
        path?: MessageInit<PathfindOptions>;
        priority?: BotTaskPriority;
        radius?: number;
        reconnectPolicy?: BotTaskReconnectPolicy;
        restoreSelectedSlot?: boolean;
        selectBestWeapon?: boolean;
        sprinting?: boolean;
        weapon?: MessageInit<ItemSelector>;
    }

    Hierarchy (View Summary)

    Index
    attackRange? call? causationId? completeWhenNoTarget? conflictPolicy? deadline? disconnectPolicy? idempotencyKey? maximumAttacks? maximumTargets? noTargetTimeoutSeconds? parentTaskId? path? priority? radius? reconnectPolicy? restoreSelectedSlot? selectBestWeapon? sprinting? weapon?
    attackRange?: number

    Defaults to 3, at most 6.

    call?: CallOptions
    causationId?: string

    from field: optional string causation_id = 10;

    completeWhenNoTarget?: boolean

    Ends at once when no target is in sight. Defaults to true for attackNearest, false for runAttackNearest.

    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;

    maximumAttacks?: number

    0 (the default) means no limit.

    maximumTargets?: number

    Targets to defeat; 0 means no limit. Defaults to 1 for attackNearest, 0 for runAttackNearest.

    noTargetTimeoutSeconds?: number

    How long to wait while nothing matches; 0 (the default) waits forever. At most 3600.

    parentTaskId?: string

    from field: optional string parent_task_id = 9;

    path?: MessageInit<PathfindOptions>
    priority?: BotTaskPriority

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

    radius?: number

    Search radius around the bot. Defaults to 32, at most 128.

    reconnectPolicy?: BotTaskReconnectPolicy

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

    restoreSelectedSlot?: boolean

    Defaults to true.

    selectBestWeapon?: boolean

    Defaults to true.

    sprinting?: boolean
    weapon?: MessageInit<ItemSelector>

    Settings
    Member Visibility

    On This Page
    Properties