Interface AircraftControllerConfig

Runtime configuration for AircraftController.

Most fields are optional overrides around practical defaults. Distances, speeds and offsets are in the active Scene coordinate system. Directional vectors follow the Scene coordinate system's world-up convention.

interface AircraftControllerConfig {
    acceleration?: number;
    afterburner?: boolean | AircraftAfterburnerConfig;
    bodyRadius?: number;
    brakeDeceleration?: number;
    cameraCockpitEyeOffset?: ArrayLike<number>;
    cameraCockpitLookOffset?: ArrayLike<number>;
    cameraDistance?: number;
    cameraExteriorDistanceScale?: number;
    cameraExteriorDistanceStep?: number;
    cameraExteriorMaxDistanceScale?: number;
    cameraExteriorMinDistanceScale?: number;
    cameraFollowSmoothing?: number;
    cameraFrontDistanceScale?: number;
    cameraFrontHeightScale?: number;
    cameraFrontLookAheadScale?: number;
    cameraFrontMinDistance?: number;
    cameraFrontMinDistanceScale?: number;
    cameraHeight?: number;
    cameraLateralOffset?: number;
    cameraLookAhead?: number;
    cameraLookHeight?: number;
    cameraLookSmoothing?: number;
    cameraRearWideDistanceScale?: number;
    cameraRearWideHeightScale?: number;
    cameraRearWideLookAheadScale?: number;
    cameraSideDistanceScale?: number;
    cameraSideHeightScale?: number;
    cameraSideLookAheadScale?: number;
    cameraTopHeight?: number;
    cameraTopTrailingDistance?: number;
    cameraTrailFollow?: number;
    cameraTrailHeight?: number;
    coastDeceleration?: number;
    collision?: boolean;
    exhaust?: AircraftExhaustConfig;
    exhaustPlume?: boolean | AircraftExhaustConfig;
    flightAcceleration?: number;
    flightAirDrag?: number;
    flightBrakeDeceleration?: number;
    flightGravity?: number;
    flightLandingFallSpeed?: number;
    flightMinGlideSpeed?: number;
    flightPitchRateDegreesPerSecond?: number;
    flightSoftLandingRange?: number;
    flightSteeringResponse?: number;
    flightTakeoffHeight?: number;
    flightTakeoffSpeed?: number;
    forwardAxis?: string;
    gravity?: boolean;
    initialShipPosition?: ArrayLike<number>;
    keySteerInitialScale?: number;
    keySteerRampSeconds?: number;
    leanDegrees?: number;
    leanSmoothing?: number;
    maxForwardSpeed?: number;
    maxMouseDragInputPerFrame?: number;
    maxReverseSpeed?: number;
    maxShipMouseDragInputPerFrame?: number;
    maxShipPitchDegrees?: number;
    maxVisualRollDegrees?: number;
    minAltitude?: number;
    minForwardSpeed?: number;
    minShipPitchDegrees?: number;
    modelId?: string;
    mouseDragPitchSensitivity?: number;
    mouseDragResponse?: number;
    mouseDragYawSensitivity?: number;
    rollSmoothing?: number;
    shipKeyYawInitialScale?: number;
    shipKeyYawRampSeconds?: number;
    shipMouseDragPitchSensitivity?: number;
    shipMouseDragResponse?: number;
    shipMouseDragSensitivity?: number;
    shipMouseDragYawSensitivity?: number;
    shipPitchRateDegreesPerSecond?: number;
    shipYawRateDegreesPerSecond?: number;
    startFlying?: boolean;
    startSpeed?: number;
    turnRateDegreesPerSecond?: number;
    vehicleVisualSmoothing?: number;
    [key: string]: unknown;
}

Indexable

  • [key: string]: unknown

    Allows demos to pass through extra controller-specific values.

Properties

acceleration? afterburner? bodyRadius? brakeDeceleration? cameraCockpitEyeOffset? cameraCockpitLookOffset? cameraDistance? cameraExteriorDistanceScale? cameraExteriorDistanceStep? cameraExteriorMaxDistanceScale? cameraExteriorMinDistanceScale? cameraFollowSmoothing? cameraFrontDistanceScale? cameraFrontHeightScale? cameraFrontLookAheadScale? cameraFrontMinDistance? cameraFrontMinDistanceScale? cameraHeight? cameraLateralOffset? cameraLookAhead? cameraLookHeight? cameraLookSmoothing? cameraRearWideDistanceScale? cameraRearWideHeightScale? cameraRearWideLookAheadScale? cameraSideDistanceScale? cameraSideHeightScale? cameraSideLookAheadScale? cameraTopHeight? cameraTopTrailingDistance? cameraTrailFollow? cameraTrailHeight? coastDeceleration? collision? exhaust? exhaustPlume? flightAcceleration? flightAirDrag? flightBrakeDeceleration? flightGravity? flightLandingFallSpeed? flightMinGlideSpeed? flightPitchRateDegreesPerSecond? flightSoftLandingRange? flightSteeringResponse? flightTakeoffHeight? flightTakeoffSpeed? forwardAxis? gravity? initialShipPosition? keySteerInitialScale? keySteerRampSeconds? leanDegrees? leanSmoothing? maxForwardSpeed? maxMouseDragInputPerFrame? maxReverseSpeed? maxShipMouseDragInputPerFrame? maxShipPitchDegrees? maxVisualRollDegrees? minAltitude? minForwardSpeed? minShipPitchDegrees? modelId? mouseDragPitchSensitivity? mouseDragResponse? mouseDragYawSensitivity? rollSmoothing? shipKeyYawInitialScale? shipKeyYawRampSeconds? shipMouseDragPitchSensitivity? shipMouseDragResponse? shipMouseDragSensitivity? shipMouseDragYawSensitivity? shipPitchRateDegreesPerSecond? shipYawRateDegreesPerSecond? startFlying? startSpeed? turnRateDegreesPerSecond? vehicleVisualSmoothing?

Properties

Optionalacceleration

acceleration?: number

Ground acceleration.

Optionalafterburner

afterburner?: boolean | AircraftAfterburnerConfig

Afterburner config, shared with the exhaust emitter.

OptionalbodyRadius

bodyRadius?: number

Collision body radius supplied to vehicle navigation.

OptionalbrakeDeceleration

brakeDeceleration?: number

Ground braking deceleration.

OptionalcameraCockpitEyeOffset

cameraCockpitEyeOffset?: ArrayLike<number>

Aircraft-local cockpit eye offset.

OptionalcameraCockpitLookOffset

cameraCockpitLookOffset?: ArrayLike<number>

Aircraft-local cockpit look target offset.

OptionalcameraDistance

cameraDistance?: number

Base chase-camera distance.

OptionalcameraExteriorDistanceScale

cameraExteriorDistanceScale?: number

Initial multiplier for exterior camera distances.

OptionalcameraExteriorDistanceStep

cameraExteriorDistanceStep?: number

Multiplicative step used by - / + exterior-camera zoom keys.

OptionalcameraExteriorMaxDistanceScale

cameraExteriorMaxDistanceScale?: number

Maximum exterior distance multiplier.

OptionalcameraExteriorMinDistanceScale

cameraExteriorMinDistanceScale?: number

Minimum exterior distance multiplier.

OptionalcameraFollowSmoothing

cameraFollowSmoothing?: number

Smoothing factor for exterior camera eye movement.

OptionalcameraFrontDistanceScale

cameraFrontDistanceScale?: number

Front-camera distance multiplier.

OptionalcameraFrontHeightScale

cameraFrontHeightScale?: number

Front-camera height multiplier.

OptionalcameraFrontLookAheadScale

cameraFrontLookAheadScale?: number

Front-camera look-ahead multiplier.

OptionalcameraFrontMinDistance

cameraFrontMinDistance?: number

Minimum front-camera distance from the aircraft.

OptionalcameraFrontMinDistanceScale

cameraFrontMinDistanceScale?: number

Front-camera minimum distance as a fraction of desired distance.

OptionalcameraHeight

cameraHeight?: number

Base chase-camera height.

OptionalcameraLateralOffset

cameraLateralOffset?: number

Right-axis offset for the trailing camera.

OptionalcameraLookAhead

cameraLookAhead?: number

Distance ahead of the aircraft that the chase camera looks.

OptionalcameraLookHeight

cameraLookHeight?: number

World-up offset added to camera look targets.

OptionalcameraLookSmoothing

cameraLookSmoothing?: number

Smoothing factor for exterior camera look movement.

OptionalcameraRearWideDistanceScale

cameraRearWideDistanceScale?: number

Rear-wide camera distance multiplier.

OptionalcameraRearWideHeightScale

cameraRearWideHeightScale?: number

Rear-wide camera height multiplier.

OptionalcameraRearWideLookAheadScale

cameraRearWideLookAheadScale?: number

Rear-wide camera look-ahead multiplier.

OptionalcameraSideDistanceScale

cameraSideDistanceScale?: number

Side-camera distance multiplier.

OptionalcameraSideHeightScale

cameraSideHeightScale?: number

Side-camera height multiplier.

OptionalcameraSideLookAheadScale

cameraSideLookAheadScale?: number

Side-camera look-ahead multiplier.

OptionalcameraTopHeight

cameraTopHeight?: number

Top-camera height.

OptionalcameraTopTrailingDistance

cameraTopTrailingDistance?: number

Backward offset for the top-trailing camera.

OptionalcameraTrailFollow

cameraTrailFollow?: number

Blend amount toward an exhaust-tethered trailing camera.

OptionalcameraTrailHeight

cameraTrailHeight?: number

Up offset used by the exhaust-tethered trailing camera.

OptionalcoastDeceleration

coastDeceleration?: number

Passive deceleration while coasting.

Optionalcollision

collision?: boolean

Enables collision against non-aircraft objects.

Optionalexhaust

exhaust?: AircraftExhaustConfig

Exhaust trail configuration.

OptionalexhaustPlume

exhaustPlume?: boolean | AircraftExhaustConfig

Backward-compatible exhaust trail flag/config alias.

OptionalflightAcceleration

flightAcceleration?: number

Flight acceleration.

OptionalflightAirDrag

flightAirDrag?: number

Flight drag coefficient.

OptionalflightBrakeDeceleration

flightBrakeDeceleration?: number

Flight braking deceleration.

OptionalflightGravity

flightGravity?: number

Flight gravity acceleration.

OptionalflightLandingFallSpeed

flightLandingFallSpeed?: number

Falling speed used during landing.

OptionalflightMinGlideSpeed

flightMinGlideSpeed?: number

Minimum glide speed while flying.

OptionalflightPitchRateDegreesPerSecond

flightPitchRateDegreesPerSecond?: number

Flight pitch rate in degrees per second.

OptionalflightSoftLandingRange

flightSoftLandingRange?: number

Distance over which landing is softened.

OptionalflightSteeringResponse

flightSteeringResponse?: number

Responsiveness of flight steering.

OptionalflightTakeoffHeight

flightTakeoffHeight?: number

Altitude at which flight mode starts.

OptionalflightTakeoffSpeed

flightTakeoffSpeed?: number

Speed required before takeoff.

OptionalforwardAxis

forwardAxis?: string

Which local aircraft axis points forward. Defaults to "-Z".

Optionalgravity

gravity?: boolean

Enables gravity in the underlying vehicle controller.

OptionalinitialShipPosition

initialShipPosition?: ArrayLike<number>

Initial world-space aircraft position. If omitted, derived from the View camera.

OptionalkeySteerInitialScale

keySteerInitialScale?: number

Generic alias for keyboard steer initial multiplier.

OptionalkeySteerRampSeconds

keySteerRampSeconds?: number

Generic alias for keyboard steering ramp seconds.

OptionalleanDegrees

leanDegrees?: number

Generic alias for maximum visual roll/lean in degrees.

OptionalleanSmoothing

leanSmoothing?: number

Generic alias for roll smoothing.

OptionalmaxForwardSpeed

maxForwardSpeed?: number

Maximum forward speed.

OptionalmaxMouseDragInputPerFrame

maxMouseDragInputPerFrame?: number

Generic alias for maximum mouse-drag input per frame.

OptionalmaxReverseSpeed

maxReverseSpeed?: number

Maximum reverse speed.

OptionalmaxShipMouseDragInputPerFrame

maxShipMouseDragInputPerFrame?: number

Maximum mouse-drag input consumed in one frame.

OptionalmaxShipPitchDegrees

maxShipPitchDegrees?: number

Maximum pitch angle in degrees.

OptionalmaxVisualRollDegrees

maxVisualRollDegrees?: number

Maximum visual roll/lean in degrees.

OptionalminAltitude

minAltitude?: number

Minimum altitude along world-up; below this, the controller clamps upward.

OptionalminForwardSpeed

minForwardSpeed?: number

Alias for minimum forward/glide speed.

OptionalminShipPitchDegrees

minShipPitchDegrees?: number

Minimum pitch angle in degrees.

OptionalmodelId

modelId?: string

ID prefix for the aircraft SceneModel, used by the default collision filter.

OptionalmouseDragPitchSensitivity

mouseDragPitchSensitivity?: number

Generic alias for mouse-drag pitch sensitivity.

OptionalmouseDragResponse

mouseDragResponse?: number

Generic mouse-drag response smoothing.

OptionalmouseDragYawSensitivity

mouseDragYawSensitivity?: number

Generic alias for mouse-drag yaw sensitivity.

OptionalrollSmoothing

rollSmoothing?: number

Roll smoothing factor.

OptionalshipKeyYawInitialScale

shipKeyYawInitialScale?: number

Initial keyboard steer multiplier before ramping.

OptionalshipKeyYawRampSeconds

shipKeyYawRampSeconds?: number

Seconds for keyboard steering to ramp to full strength.

OptionalshipMouseDragPitchSensitivity

shipMouseDragPitchSensitivity?: number

Mouse-drag pitch sensitivity.

OptionalshipMouseDragResponse

shipMouseDragResponse?: number

Aircraft-demo alias for mouse-drag response smoothing.

OptionalshipMouseDragSensitivity

shipMouseDragSensitivity?: number

Shared mouse-drag sensitivity fallback.

OptionalshipMouseDragYawSensitivity

shipMouseDragYawSensitivity?: number

Mouse-drag yaw sensitivity.

OptionalshipPitchRateDegreesPerSecond

shipPitchRateDegreesPerSecond?: number

Aircraft-demo alias for flight pitch rate.

OptionalshipYawRateDegreesPerSecond

shipYawRateDegreesPerSecond?: number

Preferred yaw rate name for aircraft demos, in degrees per second.

OptionalstartFlying

startFlying?: boolean

Whether to start in flight mode. Defaults to true.

OptionalstartSpeed

startSpeed?: number

Initial forward speed.

OptionalturnRateDegreesPerSecond

turnRateDegreesPerSecond?: number

Generic yaw rate alias, in degrees per second.

OptionalvehicleVisualSmoothing

vehicleVisualSmoothing?: number

Smoothing factor for rendered aircraft pose. Use 0 for exact pose.

Settings

Member Visibility

On This Page

Properties
accelerationafterburnerbodyRadiusbrakeDecelerationcameraCockpitEyeOffsetcameraCockpitLookOffsetcameraDistancecameraExteriorDistanceScalecameraExteriorDistanceStepcameraExteriorMaxDistanceScalecameraExteriorMinDistanceScalecameraFollowSmoothingcameraFrontDistanceScalecameraFrontHeightScalecameraFrontLookAheadScalecameraFrontMinDistancecameraFrontMinDistanceScalecameraHeightcameraLateralOffsetcameraLookAheadcameraLookHeightcameraLookSmoothingcameraRearWideDistanceScalecameraRearWideHeightScalecameraRearWideLookAheadScalecameraSideDistanceScalecameraSideHeightScalecameraSideLookAheadScalecameraTopHeightcameraTopTrailingDistancecameraTrailFollowcameraTrailHeightcoastDecelerationcollisionexhaustexhaustPlumeflightAccelerationflightAirDragflightBrakeDecelerationflightGravityflightLandingFallSpeedflightMinGlideSpeedflightPitchRateDegreesPerSecondflightSoftLandingRangeflightSteeringResponseflightTakeoffHeightflightTakeoffSpeedforwardAxisgravityinitialShipPositionkeySteerInitialScalekeySteerRampSecondsleanDegreesleanSmoothingmaxForwardSpeedmaxMouseDragInputPerFramemaxReverseSpeedmaxShipMouseDragInputPerFramemaxShipPitchDegreesmaxVisualRollDegreesminAltitudeminForwardSpeedminShipPitchDegreesmodelIdmouseDragPitchSensitivitymouseDragResponsemouseDragYawSensitivityrollSmoothingshipKeyYawInitialScaleshipKeyYawRampSecondsshipMouseDragPitchSensitivityshipMouseDragResponseshipMouseDragSensitivityshipMouseDragYawSensitivityshipPitchRateDegreesPerSecondshipYawRateDegreesPerSecondstartFlyingstartSpeedturnRateDegreesPerSecondvehicleVisualSmoothing