@3dsource/metabox-front-api
    Preparing search index...

    Interface CameraCommandPayload

    Payload for the SetCamera command describing the desired camera state in the Unreal scene. All fields are optional — only the provided values will be applied.

    Defines the payload structure for camera commands. Contains camera-related parameters passed to SetCamera command.

    Read-only interface defining camera parameters: fov (degrees), mode ('orbit'|'fps'), position ({x,y,z}), rotation ({horizontal: yaw, vertical: pitch}), and restrictions (distance/FOV/rotation limits). Both returned by getCameraResult event and accepted by SetCamera.

    This interface is bidirectional — returned from GetCamera and accepted by SetCamera. Capture a camera state via getCameraResult and replay it with SetCamera(payload). Only include restriction fields you want to enforce; omitted values keep current settings. In orbit mode, distance limits are relative to the orbit pivot.

    interface CameraCommandPayload {
        fov?: number;
        mode?: "fps" | "orbit";
        position?: { x: number; y: number; z: number };
        restrictions?: {
            maxDistanceToPivot?: number;
            maxFov?: number;
            maxHorizontalRotation?: number;
            maxVerticalRotation?: number;
            minDistanceToPivot?: number;
            minFov?: number;
            minHorizontalRotation?: number;
            minVerticalRotation?: number;
        };
        rotation?: { horizontal: number; vertical: number };
    }
    Index

    Properties

    fov? mode? position? restrictions? rotation?

    Properties

    fov?: number

    Field of a view angle in degrees.

    mode?: "fps" | "orbit"

    Camera control mode: 'fps' for first-person or 'orbit' for orbital rotation around pivot.

    position?: { x: number; y: number; z: number }

    Camera position in 3D world space.

    restrictions?: {
        maxDistanceToPivot?: number;
        maxFov?: number;
        maxHorizontalRotation?: number;
        maxVerticalRotation?: number;
        minDistanceToPivot?: number;
        minFov?: number;
        minHorizontalRotation?: number;
        minVerticalRotation?: number;
    }

    Min/max constraints applied to camera movement, zoom, and rotation.

    rotation?: { horizontal: number; vertical: number }

    Camera rotation angles in degrees.

    Settings

    Member Visibility

    On This Page

    What does it unlock?Practical ApplicationAI Coding Best Practices
    Properties