SoulFire TypeScript SDK 2.10.3
    Preparing search index...

    Type Alias BotWatchPovRequest

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

    Request to continuously render a bot's point of view.

    Type Declaration

    • botId: string

      from field: string bot_id = 2;

    • OptionalcameraX?: number

      from field: optional double camera_x = 7;

    • OptionalcameraY?: number

      from field: optional double camera_y = 8;

    • OptionalcameraZ?: number

      from field: optional double camera_z = 9;

    • Optionalfov?: number

      from field: optional double fov = 6;

    • height: number

      from field: int32 height = 4;

    • includeDebugTrace: boolean

      from field: bool include_debug_trace = 14;

    • OptionalincludeHands?: boolean

      from field: optional bool include_hands = 13;

    • OptionalincludeHud?: boolean

      from field: optional bool include_hud = 12;

    • instanceId: string

      from field: string instance_id = 1;

    • intervalMs: number

      Target interval between frames. Defaults to 1000 ms and is clamped to 100-60000 ms. Frames are dropped while the transport is not ready.

      from field: int32 interval_ms = 15;

    • OptionalmaxDistance?: number

      from field: optional int32 max_distance = 5;

    • width: number

      from field: int32 width = 3;

    • OptionalxRot?: number

      from field: optional float x_rot = 11;

    • OptionalyRot?: number

      from field: optional float y_rot = 10;

    from message soulfire.v1.BotWatchPovRequest