SoulFire TypeScript SDK 2.10.3
    Preparing search index...

    Type Alias ExploreTask

    ExploreTask: Message<"soulfire.v1.ExploreTask"> & {
        maximumWaypoints: number;
        options?: PathfindOptions;
        origin?: BlockPosition;
        purpose: string;
        radius: number;
        returnToOrigin: boolean;
        waypointSpacing: number;
    }

    Visits coordinated frontier cells around an origin.

    Type Declaration

    • maximumWaypoints: number

      Zero explores every frontier cell or runs until cancellation.

      from field: uint32 maximum_waypoints = 4;

    • Optionaloptions?: PathfindOptions

      from field: soulfire.v1.PathfindOptions options = 5;

    • Optionalorigin?: BlockPosition

      Omitted origin uses the bot position when the task starts.

      from field: optional soulfire.v1.BlockPosition origin = 1;

    • purpose: string

      Shared purpose groups frontier claims across bots.

      from field: string purpose = 7;

    • radius: number

      Maximum horizontal distance from the origin. Zero selects the server default.

      from field: uint32 radius = 2;

    • returnToOrigin: boolean

      Returns to the origin after a bounded waypoint limit.

      from field: bool return_to_origin = 6;

    • waypointSpacing: number

      Distance between frontier cells. Zero selects the server default.

      from field: uint32 waypoint_spacing = 3;

    from message soulfire.v1.ExploreTask