Class SoulFireCamera

Captures POV images and map-ready world snapshots for one bot.

Index

Constructors

Methods

capture captureBytes frames worldMap

Constructors

constructor

new SoulFireCamera(
    instanceId: string,
    botId: string,
    client: Client<typeof BotService>,
): SoulFireCamera
Parameters
- instanceId: string
- botId: string
- client: Client<typeof BotService>
Returns SoulFireCamera
- Defined in sdk/typescript/src/camera.ts:34

Methods

capture

capture(
options?: CameraRenderOptions,
call?: CallOptions,
): Effect<BotRenderPovResponse, SoulFireOperationError>
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.
Parameters
- options: CameraRenderOptions = {}
- Optionalcall: CallOptions
Returns Effect<BotRenderPovResponse, SoulFireOperationError>
- Defined in sdk/typescript/src/camera.ts:46

captureBytes

captureBytes(
options?: CameraRenderOptions,
call?: CallOptions,
): Effect<Uint8Array<ArrayBufferLike>, SoulFireOperationError>
The capture image, decoded.
Parameters
- options: CameraRenderOptions = {}
- Optionalcall: CallOptions
Returns Effect<Uint8Array<ArrayBufferLike>, SoulFireOperationError>
- Defined in sdk/typescript/src/camera.ts:61

frames

frames(
options?: CameraStreamOptions,
): Stream<BotPovFrame, SoulFireOperationError>
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.
Parameters
- options: CameraStreamOptions = {}
Returns Stream<BotPovFrame, SoulFireOperationError>
- Defined in sdk/typescript/src/camera.ts:74

worldMap

worldMap(
options?: WorldMapOptions,
call?: CallOptions,
): Effect<BotWorldMapResponse, SoulFireOperationError>
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.
Parameters
- options: WorldMapOptions = {}
- Optionalcall: CallOptions
Returns Effect<BotWorldMapResponse, SoulFireOperationError>
- Defined in sdk/typescript/src/camera.ts:95