Class SoulFirePathfinder

Index

Constructors

Methods

follow goTo plan run runFollow

Constructors

constructor

new SoulFirePathfinder(
    instanceId: string,
    botId: string,
    client: Client<typeof PathfinderService>,
    tasks: SoulFireTasks,
): SoulFirePathfinder
Parameters
- instanceId: string
- botId: string
- client: Client<typeof PathfinderService>
- tasks: SoulFireTasks
Returns SoulFirePathfinder
- Defined in sdk/typescript/src/pathfinding.ts:43

Methods

follow

follow(
    target: EntityTarget,
    distance?: number,
    options?: FollowEntityTaskOptions,
): Effect<SoulFireTask<GenMessage<FollowEntityTaskResult>>>
Same as tasks.followEntity: distance defaults to 3.
Parameters
- target: EntityTarget
- distance: number = 3
- options: FollowEntityTaskOptions = {}
Returns Effect<SoulFireTask<GenMessage<FollowEntityTaskResult>>>
- Defined in sdk/typescript/src/pathfinding.ts:106

goTo

goTo(
goal: PathfindGoal,
options?: GoToTaskOptions,
): Effect<SoulFireTask<GenMessage<GoToTaskResult>>>
Same as tasks.goTo.
Parameters
- goal: PathfindGoal
- options: GoToTaskOptions = {}
Returns Effect<SoulFireTask<GenMessage<GoToTaskResult>>>
- Defined in sdk/typescript/src/pathfinding.ts:86

plan

plan(
goal: PathfindGoal,
options?: PlanPathOptions,
): Effect<PathPlan, SoulFireOperationError>
Plans a route to goal from the loaded world, without moving the bot.
Parameters
- goal: PathfindGoal
- options: PlanPathOptions = {}
Returns Effect<PathPlan, SoulFireOperationError>
- Defined in sdk/typescript/src/pathfinding.ts:54

run

run(goal: PathfindGoal, options?: GoToTaskOptions): Stream<BotTaskEvent>
Same as tasks.runGoTo.
Parameters
- goal: PathfindGoal
- options: GoToTaskOptions = {}
Returns Stream<BotTaskEvent>
- Defined in sdk/typescript/src/pathfinding.ts:96

runFollow

runFollow(
    target: EntityTarget,
    distance?: number,
    options?: FollowEntityTaskOptions,
): Stream<BotTaskEvent>
Same as tasks.runFollowEntity: distance defaults to 3.
Parameters
- target: EntityTarget
- distance: number = 3
- options: FollowEntityTaskOptions = {}
Returns Stream<BotTaskEvent>
- Defined in sdk/typescript/src/pathfinding.ts:117