SoulFire TypeScript SDK 2.10.3
    Preparing search index...

    Interface FleeTaskOptions

    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 FleeTaskOptions {
        call?: CallOptions;
        causationId?: string;
        completeWhenSafe?: boolean;
        conflictPolicy?: BotTaskConflictPolicy;
        deadline?: Date;
        disconnectPolicy?: BotTaskDisconnectPolicy;
        idempotencyKey?: string;
        maximumEscapes?: number;
        parentTaskId?: string;
        path?: MessageInit<PathfindOptions>;
        priority?: BotTaskPriority;
        reconnectPolicy?: BotTaskReconnectPolicy;
        safeDistance?: number;
        safeSeconds?: number;
        triggerRadius?: number;
    }

    Hierarchy (View Summary)

    Index
    call? causationId? completeWhenSafe? conflictPolicy? deadline? disconnectPolicy? idempotencyKey? maximumEscapes? parentTaskId? path? priority? reconnectPolicy? safeDistance? safeSeconds? triggerRadius?
    call?: CallOptions
    causationId?: string

    from field: optional string causation_id = 10;

    completeWhenSafe?: boolean

    Ends after an escape instead of watching for more. Defaults to true for flee, false for runFlee.

    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;

    maximumEscapes?: 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;

    safeDistance?: number

    How far from the threat counts as safe. Defaults to 16, at most 128; more than triggerRadius.

    safeSeconds?: number

    Seconds the bot must stay safe for an escape to count. Defaults to 2, at most 300.

    triggerRadius?: number

    Starts fleeing when a threat is this close. Defaults to 8, at most 128.

    Settings
    Member Visibility

    On This Page
    Properties