SoulFire TypeScript SDK 2.10.3
    Preparing search index...

    Type Alias BotRenderPovRequest

    BotRenderPovRequest: Message<"soulfire.v1.BotRenderPovRequest"> & {
        botId: string;
        cameraX?: number;
        cameraY?: number;
        cameraZ?: number;
        fov?: number;
        height: number;
        includeDebugTrace: boolean;
        includeHands?: boolean;
        includeHud?: boolean;
        instanceId: string;
        maxDistance?: number;
        width: number;
        xRot?: number;
        yRot?: number;
    }

    Request to render the bot's point-of-view as an image. Uses headless Vulkan rendering to generate a PNG image of what the bot sees.

    Type Declaration

    • botId: string

      The profile UUID of the bot to render POV for.

      from field: string bot_id = 2;

    • OptionalcameraX?: number

      Optional camera X coordinate. Defaults to the bot's current eye position.

      from field: optional double camera_x = 7;

    • OptionalcameraY?: number

      Optional camera Y coordinate. Defaults to the bot's current eye position.

      from field: optional double camera_y = 8;

    • OptionalcameraZ?: number

      Optional camera Z coordinate. Defaults to the bot's current eye position.

      from field: optional double camera_z = 9;

    • Optionalfov?: number

      Vertical field of view in degrees. Default: the renderer default FOV. Valid range: 1.0 to 179.0.

      from field: optional double fov = 6;

    • height: number

      Desired image height in pixels. Default: 480 (if 0 or not provided). Maximum: 1080 (values above this are clamped). Minimum: 1 (values below this are clamped).

      from field: int32 height = 4;

    • includeDebugTrace: boolean

      Whether to include renderer debug counters in the response. Default: false.

      from field: bool include_debug_trace = 14;

    • OptionalincludeHands?: boolean

      Whether to render first-person hands and held items. Default: true.

      from field: optional bool include_hands = 13;

    • OptionalincludeHud?: boolean

      Whether to render the HUD overlay. Default: true.

      from field: optional bool include_hud = 12;

    • instanceId: string

      The UUID of the SoulFire instance containing the bot.

      from field: string instance_id = 1;

    • OptionalmaxDistance?: number

      Maximum render distance in blocks. Default: the bot's current render distance setting. Maximum: 2048 (values above this are clamped).

      from field: optional int32 max_distance = 5;

    • width: number

      Desired image width in pixels. Default: 854 (if 0 or not provided). Maximum: 1920 (values above this are clamped). Minimum: 1 (values below this are clamped).

      from field: int32 width = 3;

    • OptionalxRot?: number

      Optional pitch in degrees. Defaults to the bot's current pitch.

      from field: optional float x_rot = 11;

    • OptionalyRot?: number

      Optional yaw in degrees. Defaults to the bot's current yaw.

      from field: optional float y_rot = 10;

    from message soulfire.v1.BotRenderPovRequest

    Settings
    Member Visibility