SoulFire LogoSoulFire

SoulFirePathfinder

Public Python members of SoulFirePathfinder.

Generated from the pinned SDK source. Use the matching installation. Each source link points to this baseline.

Methods decorated with @fn return effects. Their implementation signatures use EffectGen for the generator body. Compose them with yield from inside a scoped workflow.

plan

@fn("SoulFirePathfinder.plan")
def plan(
    self,
    goal: PathfindGoal,
    *,
    options: PathfindOptions | None = None,
    include_descriptions: bool = False,
    headers: dict[str, str] | None = None,
    timeout_ms: int | None = None,
) -> EffectGen[PathPlan, SoulFireOperationError]

Source

go_to

@fn("SoulFirePathfinder.go_to")
def go_to(
    self,
    goal: PathfindGoal,
    *,
    options: PathfindOptions | None = None,
    conflict_policy: BotTaskConflictPolicy = BOT_TASK_CONFLICT_POLICY_UNSPECIFIED,
    reconnect_policy: BotTaskReconnectPolicy = BOT_TASK_RECONNECT_POLICY_UNSPECIFIED,
    priority: BotTaskPriority = BOT_TASK_PRIORITY_UNSPECIFIED,
    deadline: datetime | None = None,
    idempotency_key: str | None = None,
    headers: dict[str, str] | None = None,
    timeout_ms: int | None = None,
) -> EffectGen[SoulFireTask[GoToTaskResult], SoulFireOperationError]

Source

run

def run(
    self,
    goal: PathfindGoal,
    *,
    options: PathfindOptions | None = None,
    reconnect_policy: BotTaskReconnectPolicy = BOT_TASK_RECONNECT_POLICY_UNSPECIFIED,
    deadline: datetime | None = None,
    idempotency_key: str | None = None,
    headers: dict[str, str] | None = None,
    timeout_ms: int | None = None,
) -> Stream[BotTaskEvent, SoulFireOperationError]

Source

follow

@fn("SoulFirePathfinder.follow")
def follow(
    self,
    target: EntityTargetLike,
    *,
    distance: float = 3,
    options: PathfindOptions | None = None,
    target_unavailable_timeout_seconds: int = 0,
    conflict_policy: BotTaskConflictPolicy = BOT_TASK_CONFLICT_POLICY_UNSPECIFIED,
    reconnect_policy: BotTaskReconnectPolicy = BOT_TASK_RECONNECT_POLICY_UNSPECIFIED,
    priority: BotTaskPriority = BOT_TASK_PRIORITY_UNSPECIFIED,
    deadline: datetime | None = None,
    idempotency_key: str | None = None,
    headers: dict[str, str] | None = None,
    timeout_ms: int | None = None,
) -> EffectGen[SoulFireTask[FollowEntityTaskResult], SoulFireOperationError]

Source

run_follow

def run_follow(
    self,
    target: EntityTargetLike,
    *,
    distance: float = 3,
    options: PathfindOptions | None = None,
    target_unavailable_timeout_seconds: int = 0,
    reconnect_policy: BotTaskReconnectPolicy = BOT_TASK_RECONNECT_POLICY_UNSPECIFIED,
    deadline: datetime | None = None,
    idempotency_key: str | None = None,
    headers: dict[str, str] | None = None,
    timeout_ms: int | None = None,
) -> Stream[BotTaskEvent, SoulFireOperationError]

Source

How is this page?

Last updated on

On this page