Small World Engine API Reference - v0.76.20
    Preparing search index...

    Interface OrbitControllerOptions

    Configuration for the OrbitController.

    interface OrbitControllerOptions {
        audio?: AudioSystem;
        enableRotation?: boolean;
        input?: InputInterface;
        lookSensitivity?: number;
        maxPhi?: number;
        minPhi?: number;
        rotationSpeed?: number;
    }
    Index
    audio? enableRotation? input? lookSensitivity? maxPhi? minPhi? rotationSpeed?
    audio?: AudioSystem

    Audio system reference. Required — no global fallback.

    enableRotation?: boolean

    Whether rotation (Mouse) is enabled. Defaults to true.

    input?: InputInterface

    The input source. Required for reading mouse/pointer lock state.

    lookSensitivity?: number

    Look sensitivity. Defaults to 0.005.

    maxPhi?: number

    Maximum vertical angle (phi) in radians. Defaults to PI - 0.01.

    minPhi?: number

    Minimum vertical angle (phi) in radians. Defaults to 0.01.

    rotationSpeed?: number

    Rotation speed for keyboard. Defaults to 2.0.

    Settings
    Member Visibility

    On This Page
    Properties