SoulFire TypeScript SDK 2.10.3
    Preparing search index...

    Type Alias PathfindOptions

    PathfindOptions: Message<"soulfire.v1.PathfindOptions"> & {
        additionalPlaceItemIds: string[];
        allowMining: boolean;
        allowPlacing: boolean;
        avoidFluids: boolean;
        breakBlockPenalty?: number;
        maximumExpandedStates: number;
        maximumFallDistance?: number;
        maximumParkourGap?: number;
        maximumQualityBound?: number;
        maximumY?: number;
        minimumY?: number;
        placeBlockPenalty?: number;
        protectedBlocks: BlockPosition[];
        searchMode: PathfindSearchMode;
        searchTimeoutSeconds: number;
        smoothCamera?: boolean;
        sprint?: boolean;
        timeoutSeconds: number;
    }

    Type Declaration

    • additionalPlaceItemIds: string[]

      Additional block item ids that pathfinding may place after exhausting its built-in disposable building blocks. This is request-scoped and should be used sparingly for recovery paths that would otherwise leave a bot stranded.

      from field: repeated string additional_place_item_ids = 8;

    • allowMining: boolean

      If true, the bot may break blocks along the path when necessary.

      from field: bool allow_mining = 1;

    • allowPlacing: boolean

      If true, the bot may place blocks (e.g. bridge, pillar) when necessary.

      from field: bool allow_placing = 2;

    • avoidFluids: boolean

      If true, candidate movements whose feet or head would enter fluid are excluded from the route.

      from field: bool avoid_fluids = 7;

    • OptionalbreakBlockPenalty?: number

      Extra planner cost for breaking a block. Unset uses server settings.

      from field: optional double break_block_penalty = 5;

    • maximumExpandedStates: number

      Hard state-expansion budget for the complete ARA* repair session. 0 uses the server default. Reaching this limit is reported separately from an unreachable goal.

      from field: uint32 maximum_expanded_states = 15;

    • OptionalmaximumFallDistance?: number

      Largest ordinary fall onto solid ground. Values above 3 are rejected because longer falls require a dedicated safe-landing primitive.

      from field: optional uint32 maximum_fall_distance = 16;

    • OptionalmaximumParkourGap?: number

      Largest unsupported horizontal gap that parkour may cross. Set to 0 to disable parkour. Values above 3 are rejected by the current controller.

      from field: optional uint32 maximum_parkour_gap = 17;

    • OptionalmaximumQualityBound?: number

      Largest accepted certified multiplicative quality bound. Values must be from 1.0 through the selected mode's initial epsilon. Unset uses the mode default. ARA* does not execute an incumbent that misses this bound.

      from field: optional double maximum_quality_bound = 13;

    • OptionalmaximumY?: number

      from field: optional int32 maximum_y = 11;

    • OptionalminimumY?: number

      Optional inclusive elevation bounds for the bot's feet along the route. These keep a route on the surface or within a mining layer without constraining blocks that actions may reach from the route.

      from field: optional int32 minimum_y = 10;

    • OptionalplaceBlockPenalty?: number

      Extra planner cost for placing a block. Unset uses server settings.

      from field: optional double place_block_penalty = 6;

    • protectedBlocks: BlockPosition[]

      Blocks the route may move around but must never break. Positions in a different dimension are rejected instead of being silently reinterpreted in the bot's current dimension.

      from field: repeated soulfire.v1.BlockPosition protected_blocks = 18;

    • searchMode: PathfindSearchMode

      Search quality and latency policy. Unset uses NORMAL.

      from field: soulfire.v1.PathfindSearchMode search_mode = 12;

    • searchTimeoutSeconds: number

      Overrides the server's path search timeout. 0 means server default.

      from field: uint32 search_timeout_seconds = 4;

    • OptionalsmoothCamera?: boolean

      Smooth camera movement only inside movement-specific safe tolerances. Block interactions and precision movement remain deterministic.

      from field: optional bool smooth_camera = 14;

    • Optionalsprint?: boolean

      Whether ordinary forward path traversal should sprint. Unset preserves the server default of sprinting. Set false for hunger-efficient travel.

      from field: optional bool sprint = 9;

    • timeoutSeconds: number

      Maximum wall-clock seconds for planning + traversal. 0 means server default.

      from field: int32 timeout_seconds = 3;

    from message soulfire.v1.PathfindOptions

    Settings
    Member Visibility