SoulFire LogoSoulFire

SoulFireRecipes

Public TypeScript members of SoulFireRecipes.

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

Compose Effect operations with yield* inside a scoped workflow. Properties expose sub-clients and state.

list

Recipes in the bot's recipe book (the ones it has unlocked), sorted by id. pageSize defaults to 100, at most 1000; pass nextPageToken back as pageToken for the next page.

list(
  request: RecipeRequest<typeof ListRecipesRequestSchema> = {},
  options?: CallOptions,
): Effect.Effect<ListRecipesResponse, SoulFireOperationError>

Source

canCraft

Whether the player inventory holds the ingredients for count crafts of recipeId, what is missing, and the station the recipe needs. count defaults to 1.

canCraft(
  request: RecipeRequest<typeof CanCraftRequestSchema>,
  options?: CallOptions,
): Effect.Effect<CanCraftResponse, SoulFireOperationError>

Source

listVillagerTrades

Offers of the merchant menu the bot has open.

listVillagerTrades(
  options?: CallOptions,
): Effect.Effect<ListVillagerTradesResponse, SoulFireOperationError>

Source

craft

Same as tasks.craft: count is recipe operations, not output items, and defaults to 1.

craft(
  recipeId: string,
  count = 1,
  options: CraftTaskOptions = {},
): Effect.Effect<
  SoulFireTask<typeof CraftTaskResultSchema>,
  SoulFireOperationError
>

Source

runCraft

Same as tasks.runCraft: count is recipe operations, not output items, and defaults to 1.

runCraft(
  recipeId: string,
  count = 1,
  options: CraftTaskOptions = {},
): Stream.Stream<BotTaskEvent, SoulFireOperationError>

Source

smelt

Same as tasks.smelt: count is input items to cook, and defaults to 1.

smelt(
  input: MessageInitShape<typeof ItemSelectorSchema>,
  count = 1,
  options: SmeltTaskOptions = {},
): Effect.Effect<
  SoulFireTask<typeof SmeltTaskResultSchema>,
  SoulFireOperationError
>

Source

runSmelt

Same as tasks.runSmelt: count is input items to cook, and defaults to 1.

runSmelt(
  input: MessageInitShape<typeof ItemSelectorSchema>,
  count = 1,
  options: SmeltTaskOptions = {},
): Stream.Stream<BotTaskEvent, SoulFireOperationError>

Source

brew

Same as tasks.brew: count is bottles to brew, and defaults to 1.

brew(
  input: MessageInitShape<typeof ItemSelectorSchema>,
  ingredient: MessageInitShape<typeof ItemSelectorSchema>,
  count = 1,
  options: BrewTaskOptions = {},
): Effect.Effect<
  SoulFireTask<typeof BrewTaskResultSchema>,
  SoulFireOperationError
>

Source

runBrew

Same as tasks.runBrew: count is bottles to brew, and defaults to 1.

runBrew(
  input: MessageInitShape<typeof ItemSelectorSchema>,
  ingredient: MessageInitShape<typeof ItemSelectorSchema>,
  count = 1,
  options: BrewTaskOptions = {},
): Stream.Stream<BotTaskEvent, SoulFireOperationError>

Source

villagerTrade

Same as tasks.villagerTrade: offerIndex is the zero-based index from listVillagerTrades, and count defaults to 1.

villagerTrade(
  offerIndex: number,
  count = 1,
  options: VillagerTradeTaskOptions = {},
): Effect.Effect<
  SoulFireTask<typeof VillagerTradeTaskResultSchema>,
  SoulFireOperationError
>

Source

runVillagerTrade

Same as tasks.runVillagerTrade: offerIndex is the zero-based index from listVillagerTrades, and count defaults to 1.

runVillagerTrade(
  offerIndex: number,
  count = 1,
  options: VillagerTradeTaskOptions = {},
): Stream.Stream<BotTaskEvent, SoulFireOperationError>

Source

How is this page?

Last updated on

On this page