Documentation
    Preparing search index...

    Interface CharacterControllerOptions

    Options for CharacterController (§12).

    interface CharacterControllerOptions {
        gravity?: number;
        grounded?: boolean;
        groundHeight?: number;
        jumpSpeed?: number;
        maxFallSpeed?: number;
        moveSpeed?: number;
        verticalVelocity?: number;
        yaw?: number;
    }
    Index
    gravity? grounded? groundHeight? jumpSpeed? maxFallSpeed? moveSpeed? verticalVelocity? yaw?
    gravity?: number

    Vertical acceleration in m/s², applied while airborne. Default DEFAULT_CHARACTER_GRAVITY. 0 is legal and means a character that never falls.

    grounded?: boolean

    Whether the character starts standing on the ground. Default false.

    groundHeight?: number

    Height of the ground plane, in metres (§7a). Default 0.

    jumpSpeed?: number

    Upward speed CharacterController.jump imparts, in m/s. Finite and >= 0; 0 means a character that cannot jump. Default 4.

    maxFallSpeed?: number

    Largest downward speed gravity may accumulate, in m/s. Finite and >= 0, or Infinity (the default) for no terminal velocity.

    moveSpeed?: number

    Speed a full move intent produces, in metres per second (§7a). Finite and >= 0. Default 1.

    verticalVelocity?: number

    Initial vertical velocity in m/s — what §79 restores for a character that was saved mid-fall. Default 0.

    yaw?: number

    Initial CharacterController.yaw, in radians (§7a). Default 0.

    Settings
    Member Visibility

    On This Page
    Properties