SoulFireCamera

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.

captureCopy Anchor Link

Renders what the bot sees as a PNG (base64 in imageBase64). The size defaults to 854x480, at most 1920x1080. The camera defaults to the bot's eyes, facing where it looks; cameraX/Y/Z, yRot and xRot move it.

capture(
  options: CameraRenderOptions = {},
  call?: CallOptions,
): Effect.Effect<BotRenderPovResponse, SoulFireOperationError>

Source

captureBytesCopy Anchor Link

The capture image, decoded.

captureBytes(
  options: CameraRenderOptions = {},
  call?: CallOptions,
): Effect.Effect<Uint8Array, SoulFireOperationError>

Source

framesCopy Anchor Link

Rendered frames, one per intervalMs, which defaults to 1000, from 100 to 60000. A slow reader gets the newest frame and a count of the dropped ones.

frames(
  options: CameraStreamOptions = {},
): Stream.Stream<BotPovFrame, SoulFireOperationError>

Source

worldMapCopy Anchor Link

Top-down terrain around centerX and centerZ, which default to the bot's position. radius defaults to 64, from 1 to 256, and sampleStep to 1, from 1 to 16. Entities too with includeEntities.

worldMap(
  options: WorldMapOptions = {},
  call?: CallOptions,
): Effect.Effect<BotWorldMapResponse, SoulFireOperationError>

Source