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

    Interface FlyControllerOptions

    Configuration options for the FlyController.

    interface FlyControllerOptions {
        audio?: AudioSystem;
        collisionRadius?: number;
        enableCollision?: boolean;
        enableMovement?: boolean;
        enableRotation?: boolean;
        enableVertical?: boolean;
        fastMultiplier?: number;
        flyInLookDirection?: boolean;
        input?: InputInterface;
        lookSensitivity?: number;
        moveSpeed?: number;
        scene?: Scene;
        slowMultiplier?: number;
    }
    Index
    audio? collisionRadius? enableCollision? enableMovement? enableRotation? enableVertical? fastMultiplier? flyInLookDirection? input? lookSensitivity? moveSpeed? scene? slowMultiplier?
    audio?: AudioSystem

    Audio system reference. Optional.

    collisionRadius?: number

    Radius of the collision sphere around the camera. Defaults to 0.45.

    enableCollision?: boolean

    Whether collisions against scene geometry are enabled. Defaults to true if scene is provided.

    enableMovement?: boolean

    Whether movement (WASD/Space/C) is enabled. Defaults to true.

    enableRotation?: boolean

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

    enableVertical?: boolean

    Whether vertical movement (Space/C or E/Q) is enabled. Defaults to true.

    fastMultiplier?: number

    Speed multiplier when holding Shift (Sprint/Boost). Defaults to 2.5.

    flyInLookDirection?: boolean

    Whether movement follows the full 3D pitch/yaw view direction. Defaults to true.

    input?: InputInterface

    Input source. Required.

    lookSensitivity?: number

    Mouse look sensitivity. Defaults to 0.004.

    moveSpeed?: number

    Base flight speed in units per second. Defaults to 7.0.

    scene?: Scene

    The scene to check for collisions against walls and obstacles.

    slowMultiplier?: number

    Speed multiplier when holding Alt/Ctrl (Precision/Slow). Defaults to 0.35.

    Settings
    Member Visibility

    On This Page
    Properties