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

    Interface FPSControllerOptions

    Configuration for the FPSController.

    interface FPSControllerOptions {
        collisionRadius?: number;
        enableCollision?: boolean;
        enableMovement?: boolean;
        enableRotation?: boolean;
        enableVertical?: boolean;
        input?: InputInterface;
        inputMode?: InputMode;
        lookSensitivity?: number;
        moveSpeed?: number;
        scene?: Scene;
    }
    Index

    Properties

    collisionRadius? enableCollision? enableMovement? enableRotation? enableVertical? input? inputMode? lookSensitivity? moveSpeed? scene?

    Properties

    collisionRadius?: number

    The radius of the collision sphere. Defaults to 0.5.

    enableCollision?: boolean

    Whether collisions are enabled. Requires a Scene reference.

    enableMovement?: boolean

    Whether movement (WASD) is enabled. Defaults to true.

    enableRotation?: boolean

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

    enableVertical?: boolean

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

    input?: InputInterface

    Optional input source (for testing). Defaults to global Input.instance.

    inputMode?: InputMode

    Input mode for A/D keys (STRAFE or TANK). Defaults to TANK.

    lookSensitivity?: number

    Look sensitivity. Defaults to 0.005.

    moveSpeed?: number

    Movement speed in units per second. Defaults to 10.

    scene?: Scene

    The scene to check for collisions.

    Settings

    Member Visibility

    On This Page

    Properties