SoulFire TypeScript SDK 2.10.3
    Preparing search index...

    Interface GuardTaskOptions

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

    Hierarchy (View Summary)

    Index
    attackRange? call? causationId? clearSeconds? completeWhenClear? conflictPolicy? deadline? disconnectPolicy? guardRadius? idempotencyKey? maximumAttacks? maximumPursuitDistance? maximumTargets? parentTaskId? path? priority? reconnectPolicy? restoreSelectedSlot? returnRadius? selectBestWeapon? sprinting? weapon?
    attackRange?: number

    Defaults to 3, at most 6.

    call?: CallOptions
    causationId?: string

    from field: optional string causation_id = 10;

    clearSeconds?: number

    Defaults to 3, at most 300.

    completeWhenClear?: boolean

    Ends once no threat is in range for clearSeconds. Defaults to true for guard and protect, false for runGuard and runProtect.

    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;

    guardRadius?: number

    How far around the guarded position or entity to look for threats. Defaults to 16, at most 128.

    idempotencyKey?: string

    from field: optional string idempotency_key = 11;

    maximumAttacks?: number

    0 (the default) means no limit.

    maximumPursuitDistance?: number

    Stops chasing beyond this distance from what it guards. Defaults to 24, at most 128; at least guardRadius.

    maximumTargets?: number

    0 (the default) means no limit.

    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.

    returnRadius?: number

    How close to what it guards the bot returns. Defaults to 3; less than the pursuit distance.

    selectBestWeapon?: boolean

    Defaults to true.

    sprinting?: boolean
    weapon?: MessageInit<ItemSelector>

    Settings
    Member Visibility

    On This Page
    Properties