SoulFire TypeScript SDK 2.10.3
    Preparing search index...

    Type Alias PathPlan

    PathPlan: Message<"soulfire.v1.PathPlan"> & {
        blocksToBreak: BlockPosition[];
        blocksToPlace: BlockPosition[];
        expandedStates: bigint;
        finalEpsilon: number;
        frontierReason: PathFrontierReason;
        generatedTransitions: bigint;
        incumbentImprovements: number;
        initialEpsilon: number;
        maximumTicks: bigint;
        partialReason?: string;
        qualityBound: number;
        repairedInconsistentStates: number;
        repairIterations: number;
        requiredQualityBound: number;
        routeCost?: PathRouteCost;
        searchElapsedMillis: bigint;
        searchMode: PathfindSearchMode;
        start?: BlockPosition;
        status: PathPlanStatus;
        steps: PathStep[];
        unavailableChunks: PathChunk[];
        worldRevision: bigint;
    }

    Type Declaration

    • blocksToBreak: BlockPosition[]

      from field: repeated soulfire.v1.BlockPosition blocks_to_break = 4;

    • blocksToPlace: BlockPosition[]

      from field: repeated soulfire.v1.BlockPosition blocks_to_place = 5;

    • expandedStates: bigint

      from field: uint64 expanded_states = 11;

    • finalEpsilon: number

      Inflation used by the last completed or interrupted ARA* stage.

      from field: double final_epsilon = 16;

    • frontierReason: PathFrontierReason

      from field: soulfire.v1.PathFrontierReason frontier_reason = 14;

    • generatedTransitions: bigint

      from field: uint64 generated_transitions = 12;

    • incumbentImprovements: number

      from field: uint32 incumbent_improvements = 19;

    • initialEpsilon: number

      Inflation used by the first ARA* search stage.

      from field: double initial_epsilon = 15;

    • maximumTicks: bigint

      from field: uint64 maximum_ticks = 6;

    • OptionalpartialReason?: string

      from field: optional string partial_reason = 7;

    • qualityBound: number

      Certified multiplicative bound for route_cost.optimization_cost. Zero means that this result contains no certified complete route.

      from field: double quality_bound = 9;

    • repairedInconsistentStates: number

      from field: uint32 repaired_inconsistent_states = 18;

    • repairIterations: number

      from field: uint32 repair_iterations = 17;

    • requiredQualityBound: number

      Maximum certified bound requested by the caller.

      from field: double required_quality_bound = 20;

    • OptionalrouteCost?: PathRouteCost

      from field: soulfire.v1.PathRouteCost route_cost = 10;

    • searchElapsedMillis: bigint

      from field: uint64 search_elapsed_millis = 13;

    • searchMode: PathfindSearchMode

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

    • Optionalstart?: BlockPosition

      from field: soulfire.v1.BlockPosition start = 2;

    • status: PathPlanStatus

      from field: soulfire.v1.PathPlanStatus status = 1;

    • steps: PathStep[]

      from field: repeated soulfire.v1.PathStep steps = 3;

    • unavailableChunks: PathChunk[]

      Chunks read by the search but absent from the captured client world.

      from field: repeated soulfire.v1.PathChunk unavailable_chunks = 22;

    • worldRevision: bigint

      Navigation-world revision captured before this search started.

      from field: uint64 world_revision = 21;

    from message soulfire.v1.PathPlan

    Settings
    Member Visibility