Retail
SDK Documentation
Retail
Retail
Flighting
Copy Page URL to Clipboard
Search
MSFS 2024 SDK Introduction
Introduction
SDK Overview
SDK Contents
Using The SDK
SDK EULA
SDK Release Notes
DevMode
Developer Mode
Report An Issue
The Colour Picker
The Edition Gizmo
Menus
DevMode
File
Editors
Tools
Tools Information
The Aircraft Capture Tool
Behaviors Debug Window
Behaviours Debug
Behavior Tabs
Behavior Viewer
Code Editor
The Career Tool
The Packages Window
The Ruler Tool
SimConnect Inspector
The Capture Batching Tool
SimObject Spawner
The SimObject Statistics Profiler
The Scenery Statistics Profiler
Teleport Window
The Virtual File System
Virtual File System Information
Virtual File System Information
The Video Capture Tool
The DevMode Toolbar
Options
Options Information
Channel Display
Debug
Debug Information
Airports
Biome Debug
Flight Planning Services Debug
Debug LODs
Debug Platform Dispatcher
Debug Weather Sim
Device Data
Device Presets
Input Actions List
SimObject Containers
Terrain
The Console
WASM Debug
Web View Profiler
Camera
Camera Information
Camera Controls
Help
Editors
Project Editor
The Project Editor
The Project Inspector
Export Window
Asset Types
Project Editor Menus
Project
Edit
View
Settings
File Formats
File Formats
CFG Files
CGL Files
BGL Files
SPB Files
XML Files
Biomes Editor
The Biomes Editor
The Biomes Inspector
Creating A Biome
Input Editors
The Input Device Editor
The Input Profile Editor
Material Editor
The Material Editor
Menus
The Material Inspector
Inspector Menus
The Bitmap Manager
ProceduralAssets Editor
The Procedural Assets Editor
Scenery Editor
The Scenery Editor
Using The Scenery Editor
Scenery Editor Object Types
Scenery Editor Menus
The Edit Menu
The View Menu
The Rendering Menu
Scenery Editor Objects
Scenery Objects
Airport Objects
Apron Objects
CarParking Objects
Decal Objects
ExclusionRectangle Objects
Helipad Objects
Jetway Objects
LandmarkLocation Objects
Mast Light Objects
Light Objects
LightRow Objects
LightSupport Objects
PaintedHatchedArea Objects
PaintedLine Objects
Polygon Objects
ProceduralInstance Objects
ProjectedMesh Objects
Rectangle Objects
Runway Objects
SimObj Objects
SimPropContainer Objects
TaxiwaySign Objects
TaxiwayParking Objects
TaxiwayPath Objects
TaxiwayPoint Objects
TaxiwayServiceStand Objects
TextMarking Objects
ControlTower Objects
Tree Objects
VDGS Objects
VectorPlacement Objects
VFX Objects
Windsock Objects
WorldScript Objects
Airport Archetype Overrides
SimObject Editor
The SimObject Editor
The SimObject Editor Graph View
Menus
The SimObject Editor Parameter Index
Cfgs
CFG Files
Custom or Erroneous Parameters
Animations
Animations
Model Lod
Model LOD
Sound
Sounds
Labels
Labels
Career
Career Compatibility
Input
Inputs
SimObject Editor Debug
SimObject Debug Menu
Debug Aircraft Attachments
Debug Aircraft CFD
ECS - Pneumatic System Debug
Electrical System Debug
Debug Aircraft Flight Performance
Fuel System Debug
Hydraulic System Debug
Debug Lights
Propeller RPM Limiter Analysis
Aerodynamics Analysis
VFX Editor
The Visual Effects Editor
Menus
Templates and Instances Debugger
VFX Editor Nodes
VFX Node Graph
Abs
Add
AtlasPlayer
BezierCurve
Clamp
Color
ColorSpaceConversion
CommentNode
Cos
Divide
Emitter
EmitterDirection
Float
GetCameraPosition
GetGroundAttribute
GetInstanceAttribute
GetParticleAttribute
GraphParameter
GravityVector
GroundDirection
Init
Lerp
LocalDirection
Multiply
Output
Pow
RandomDirectionInCone
RandomValue
SampleNoise
SetScale
SimVar
Sin
Split
StaticMesh
Subtract
Update
Vector2, Vector3, Vector4
VisualEffect
WindDirection
Navigation Graph Editor
The Navigation Graph Editor
Using The Navigation Graph Editor
Models And Textures
Models, Materials, And Textures
MSFS 2024 glTF Format
Plugins
Plugins
3DS Max Plugin
Containers
Material Tools
MSFS2024 Utilities
Multi
Simplygon Utilities
Texture Tool
The 3DS Max Plugin
Blender Plugin
The Blender Plugins
Blender Plugin Properties
Blender LOD Tools
The Blender Exporter
Blender - 3DS Max Bridge
Convert A MSFS2020 Scene To MSFS2024
Wiper Mask Generator Tool
Light Tools
glTF Schemas
Textures
Texturing Technical Information
Materials
FlightSim Materials
FlightSim Material Parameters
FlightSim Material Textures
Animated Materials
Modeling
Modeling Technical Information
Aircraft
Aircraft Modeling General Principles
Model Exporting
Modeling Aircraft
Passive Aircraft
Thumbnails
Airframe
Airframe Collision Meshes
Airframe Details
Airframe LODs
Airframe Textures And Materials
Airframe
Ambient Occlusion
Clearcoat
Covers, Chocks, And Pins
Dirt And Grime
Doors, Hatches, And Canopies
Exterior Lights
File Setup
Fuel Truck And GPU Connections
Frost And Ice
Silhouette And Material Contrast
Parallax Windows
Propellers, Turbines And Blades
Registration Numbers
Wheels
Windshield And Windows
Animations
Animating Ailerons, Flaps And Spoilers
Animating Landing Gear
Animating The Elevator
Animating The Rudder
Animations Overview
WingFlex
Wingflex
WingFlex
WingFlex
Liveries
Dynamic Liveries
Edited Liveries
Modelling Aircraft Livery
Static Liveries
Cockpit
Adding An EFB
Cockpit And Cabin Lights
Cockpit And Cabin LODs
Cockpit And Cabin Modeling General Principles
Cockpit
Cockpit Collision Meshes And Occluders
File Setup
Gauges
Geometry Optimisation
Seats And Seatbelts
VR Helpers
Animations
Animations Overview
Button, Knob, And Lever Animation
Peddle Animation
Yoke, Wheel, And Collective Animation
Textures
Ambient Occlusion
Cockpit Textures And Materials
Decals And Detail Maps
Material Mapping
Translucent Elements
Landscape
Collision Handling
Jetways
Scenery LODs
Modeling Scenery
Modeling SimPropContainers
Scenery Collision Meshes
Using Simplygon To Generate LODs
LODs
Debugging LODs
LOD Example
LOD Selection System
LOD Technical Information
Model Attachments
Submodel Merging
Sound
Sound
Using Wwise
Wwise Licence Information
Shared States and Switches
Shared Attenuation
Master Mixer Hierarchy
Audio Mixing Standards
RTPC And Simulation Variables
Sounds And Modular SimObjects
Sound Optimisations
Audio Migration And Updating
Aircraft Audio
Creating Aircraft Audio
Recording Audio
Setting Up Wwise
Creating The Sound.xml
Engine Audio Setup
Advanced Audio Effects
Advanced Sound.xml Features
Additional Wwise Tools
Audio For AI Aircraft
Content Configuration
Content Configuration
User Interface
Cameras
Cameras
RTC
Creating A Simple RTC
Creating Hangar / Showcase RTC's
RTC XML Examples
RTC XML Properties
Using RTCs
Careers
Career Activities
General Career Information
General Career Mode Requirements
Career Activities Additional Information
Preflight
Spawn Pilot (Transversal)
Aircraft Loads
Aircraft Seats And Seatbelts
Using Included SimAttachments
Aerial Advertising
Aerial Construction
Aerial Firefighting
Agricultural Aviation
Cargo Transport
Charter Service
Commercial Flights And Passengers
Ferry Flights
Flightseeing And First Flight
Medevac
Scientific Research
Search And Rescue
Skydiving
CFG Files
CFG Files General Information
CFG Parameter Index
CFG Files Obsolete Parameters
ai.cfg
aircraft.cfg
Aircraft Sim
Aircraft.cfg And Sim.cfg Additional Information
sim.cfg Examples
Air Traffic
attached_objects.cfg
attachment.cfg
cameras.cfg
Camera
cameras.cfg Examples
Implementing Cameras
cockpit.cfg
effects.cfg
engines.cfg
Engines
engines.cfg Additional Information
flight_model.cfg
Flight Model
Additional Flight Model Information
Physics Objects Information
Modular Fuel System Information
Fuel System Examples
flight_performance.cfg
Flight Performance
flight_performance.cfg Setup
flight_performance.cfg Additional Information
gameplay.cfg
livery.cfg
navigation_graph.cfg
panel.cfg
Panel
panel.cfg Examples
reference_points.cfg
sim.cfg
systems.cfg
System
Modular Electrical System Information
Electric System Setup Information
Legacy Electrical System
Modular Hydraulics System Information
Hydraulics System Setup Information
Hydraulic System Examples
Modular Pneumatics System Information
Pneumatic System Setup Information
Pneumatic System Examples
Modular Burner System Information
Modular Liquid Dropping System Information
Light FX Properties
Implementing Lights
Environment
Environment
Shared Environment XML Properties
Airports And Facilities
Airports And Facilities Information
Airport XML Properties
Runway XML Properties
Taxiway XML Properties
Approach, Arrival, And Departure XML Properties
Apron Services
Apron Services Overview
Apron Control XML Properties
Apron Services XML Properties
Global Apron Services
SimMission Apron Control XML Properties
Built in Services
Built In Apron Services
Catering
Passenger Transport
Living World
Living World
Ground Traffic
Airport Services
Airport Services Examples
Airport Services XML Properties
Airport Services
Service And IdleWorker XML Properties
Living World Config
Living World Configuration
Living World XML Examples
Living World XML Properties
Scenery Objects
Landmark Feature Classes
Scenery Editor XML Examples
Scenery Editor Objects
Scenery XML Properties
SimProp Containers
SimProp Container Object Examples
SimPropContainer XML Properties
Terrain
Aerial Scenery
CGL Aerial XML Properties
DEM
Terrain
Vector Shapes
Vegetation
Biome And Species Examples
Biome XML Properties
Biomes And Vegetation
Species XML Properties
FLT Files
FLT Files General Information
FLT File Properties
FLT Additional Information
Legacy FLT File Properties
Back On Track
Input
Input Profiles
Device Profiles
Transversal Input Profiles
Aircraft Category Input Profiles
Aircraft Specific Input Profiles
DeviceConfig XML Properties
Input Configuration XML Properties
actiondb XML Properties
remapdb XML Properties
LBL Files
LBL Files (Dynamic Libraries)
liveries.lbl
loads.lbl
material.lbl
palette.lbl
text.lbl
texture.lbl
Localization
Localization Manager
LOC Files (Localization)
Using The Localization Manager
Mission XML Files
EFB Flight Plan XML (PLN File) Properties
Event Trigger XML Properties
Flight Plan XML (PLN File) Properties
Flight, Weather and Event Examples
Flight And Mission XML Files
Mission XML Properties
Weather XML (WPR File) Properties
Mission Elements
<SimMission.Calculator>
<SimMission.CameraTargetTrigger>
<SimMission.DialogAction>
<SimMission.FlowStateAction>
<SimMission.FocusInstrumentAction>
<SimMission.ObjectInteractionTrigger>
<SimMission.Tutorial>
Travelbooks
Travelbook Lists
Travelbook Objective XML Properties
Travelbook Page XML Properties
Travelbook Setup (World Photographer Missions)
Travelbook XML Examples
Models
Animation XML Properties
model.cfg Examples
model.cfg
Model XML Examples
Model XML Properties
Models
Scenery Model XML And CFG Setup
SimObject Model XML and CFG Setup
ModelBehaviors
Template Explorer Index
Asobo
AircraftTypes
Gliders
Rotorcrafts
Airliner
Inputs
Airliner_Inputs
Airbus
AirlinerCommon
AS02A
Boeing
FMC
GlassCockpit
Common
Inputs
Aircraft_Inputs
Autopilot_Inputs
Common_Inputs
Deice_Inputs
Electrical_Inputs
Engine_Inputs
Fuel_Inputs
Handling_Inputs
Instrument_Inputs
LandingGear_Inputs
Lighting_Inputs
Passenger_Inputs
Pressurization_Inputs
Safety_Inputs
Subtemplates
Aircraft_Subtemplates
Autopilot_Subtemplates
Deice_Subtemplates
Electrical_Subtemplates
Engine_Subtemplates
Fuel_Subtemplates
Handling_Subtemplates
Instrument_Subtemplates
LandingGear_Subtemplates
Lighting_Subtemplates
Passenger_Subtemplates
Pressurization_Subtemplates
Safety_Subtemplates
Aircraft
Autopilot
Deice
Electrical
Engine
Fuel
Handling
Index.xml
Instrument
LandingGear
Lighting
Passenger
Pilot
Pressurization
Safety
Generic
Complex
Index.xml
Joystick
Knob
Lever
Misc
PushButton
Switch
Subtemplates
Animations_Subtemplates
Interactions_Subtemplates
Updates_Subtemplates
Animations
AnimationTriggers
Emissive
FX
Helpers
Index.xml
Interactions
Updates
Visibility
GlassCockpit
Inputs
AS1000_Inputs
AS3X_Inputs
AS5_Inputs
AS1000
AS3000
AS307
AS3X
AS3X_Touch
AS5
AS580
AS650
GPS
Inputs
Aera_Inputs
AS430_Inputs
Aera
AS430
AS530
Inputs
Generic
Helpers
Index.xml
Templates
Misc
Inputs
Misc_Inputs
Accelerometer
AS_EPM
ASDigiflo
ASDigitalFuelMeter_FP5L
ASPropeller
ASVigilus
Clock
GroundVehicles
GX2
Inop
Pl463
SimObjects
VoltsAmps
NAVCOM
Inputs
NavComSystem_Inputs
SimpleCom_Inputs
ADF
AS92
ASNAV
KAP140
NavComSystem
SimpleCom
Transponder
AS21
AS330
Transponder
Debug
Exterior
Asobo_EX1
Base
Component
Animation
AnimationTriggers
InputEvent
Material
Misc
Mouserect
Update
VFX
Visibility
Helper
MacroDefs
ParametersFnHelpers
Index.xml
Common
Exterior
Templates
ParametersFn
Airframe_ParametersFn
Common_ParametersFn
Engine_ParametersFn
Handling_ParametersFn
Landing_ParametersFn
Lighting_ParametersFn
SubTemplates
Common_Subtemplates
Engine_Subtemplates
Handling_Subtemplates
Landing_Subtemplates
Airframe
Common
Engine
Handling
Landing
Lighting
VFX
Index.xml
Interior
Templates
Inputs
Airframe_Inputs
Autopilot_Inputs
Auxiliary_Inputs
Common_Inputs
Deice_Inputs
Electrical_Inputs
Engine_Inputs
Fuel_Inputs
Handling_Inputs
Hydraulic_Inputs
Instrument_Inputs
Landing_Inputs
Lighting_Inputs
Pneumatics_Inputs
Radio_Inputs
Safety_Inputs
ParametersFn
InteractionPresets
Airframe_Interactions
Autopilot_Interactions
Auxiliary_Interactions
Balloon_Interactions
Common_Interactions
Deice_Interactions
Electrical_Interactions
Engine_Interactions
Fuel_Interactions
Handling_Interactions
Hydraulic_Interactions
Instrument_Interactions
Landing_Interactions
Lighting_Interactions
Pneumatics_Interactions
Radio_Interactions
Safety_Interactions
Airframe_ParametersFn
Autopilot_ParametersFn
Auxiliary_ParametersFn
Balloon_ParametersFn
Common_ParametersFn
Deice_ParametersFn
Electrical_ParametersFn
Engine_ParametersFn
Fuel_ParametersFn
Handling_ParametersFn
Hydraulic_ParametersFn
Indicators_ParametersFn
Instrument_ParametersFn
Landing_ParametersFn
Lighting_ParametersFn
Pneumatics_ParametersFn
Radio_ParametersFn
Safety_ParametersFn
SubTemplates
Airframe_SubTemplates
Autopilot_SubTemplates
Auxiliary_SubTemplates
Common_SubTemplates
Deice_SubTemplates
Electrical_SubTemplates
Engine_SubTemplates
Fuel_SubTemplates
Handling_SubTemplates
Hydraulic_SubTemplates
Indicators_SubTemplates
Instrument_SubTemplates
Landing_SubTemplates
Lighting_SubTemplates
Pneumatics_SubTemplates
Radio_SubTemplates
Safety_SubTemplates
Airframe
Autopilot
Auxiliary
Balloon
Common
Deice
EFB
Electrical
Engine
Fuel
Handling
Hydraulic
Indicators
Instrument
Landing
Lighting
Pneumatics
Radio
Safety
Index.xml
Shared
Templates
ParametersFn
InteractionPresets
Common_Interactions
Auxiliary_ParametersFn
Common_ParametersFn
Auxiliary
Common
Utils
Animations
Animation_ParametersFn
Animation_Templates
Emissives
Emissive_ParametersFn
Emissive_Templates
Interaction
Variants
Interaction_Directional_ParametersFn
Interaction_ParametersFn
Interaction_Templates
Procedures
Common
Utils
Procedures
Variables
Variables
Visibility
Visibility_ParametersFn
Visibility_Templates
Index.xml
Index.xml
Generic
Exterior
Templates
ParametersFn
Common_ParametersFn
SubTemplates
Common_Subtemplates
Common
Index.xml
Interior
Templates
ParametersFn
Variants
Interaction_Drag_Axis_ParametersFn
Interaction_XStates_ParametersFn
InputEvent_ParametersFn
Interaction_Helpers
Interaction_ParametersFn
Interaction
Index.xml
Shared
Helpers
Helpers
Templates
ParametersFn
Animation
Material
Visibility
Animation
Common
Material
Visibility
Index.xml
Index.xml
DefaultConfig
ExteriorDefs
Index.xml
InteriorDefs
WorkingTitle
GlassCockpit
Epic2v2
Autopilot
Epic2
Generic
Throttle
G3000v2
BehaviorsV1
Autopilot
Common
Controls
ESP
G3000
GDU
GTC
Inputs
UNS1v2
Uns
Template Explorer
General Template XML Properties
Ground Vehicle ModelBehavior Helpers
Help Text IDs
Input Event XML Properties
Model Behaviors
Program Template XML Properties
ToolTip Text IDs
Update Frequency Preset XML Properties
UsingBehaviours
Debugging Model Behaviors
Model Behaviors Component Overview
Model Behaviors Inputs
Model Behaviors Parameters
Using Model Behaviors
Interactions
Creating Cockpit Interactions
Adding Sound To Interactions
Creating Interaction Tooltips
Interaction Configurations
Interaction Procedures
Advanced Interactions
Templates
Custom Templates
Default Templates
Important Templates
Model Behaviors Templates
VFX
Adding Aircraft VFX
VFX Common XML Properties
VFX Template Examples
Visual Effects Templates
Modular SimObjects
Modular SimObject Merging
Modular SimObject Project Structure
Modular SimObject XML Properties
Modular SimObjects
Aircraft
Modular Aircraft SimObjects
Checklists
Checklist Best Practices
Checklist Examples
Checklist Flow
Checklist XML Properties
Checklists
Creating A Checklist
Integrator Excel File Overview
Instruments
Instruments
Panel XML Logic Elements
Panel XML Properties
Liveries
Liveries
Livery XML Examples
Livery XML Properties
SimAttachments
Sim Attachment Libraries
Sim Attachments
Included Attachments
General Attachments
Included Attachments
Instrument Attachments
SimObjects
Boats
Living Things
Procedural Characters
Non
Simple SimObjects
Ground Vehicles
Ground Vehicles Information
BaggageCart Definition
BaggageLoader Definition
BoardingRamp Definition
CateringTruck Definition
FuelTruck Definition
GroundPowerUnit Definition
PushBack Definition
Winch And Parachute Definitions
Navigation Services
Interaction Presets
Interaction XML Properties
Navigation Services XML Properties
Navigation Services And Interactions
Services XML Properties
SimMission Navigation Services
Sounds
Legacy Sound
Sound XML Examples
Sound XML Properties
Sounds
Wave Data Sound Properties
Textures
texture.cfg
Texture XML Properties
texture.json
Textures
VisualEffects
Visual Effects
Visual Effects XML Properties
Visual Effects Shared XML Elements
Visual Effects XML Examples
Programming APIs
Programming APIs
Reverse Polish Notation
Environment Variables
EFB
Electronic Flight Bag API
EFB Notifications
EFB API
Modules
classes
Class: App
Class: AppView
Class: AppViewService
Class: Container
Class: ImageCache
enums
Enum: AppBootMode
Enum: AppSuspendMode
Enum: ViewBootMode
Enum: ViewSuspendMode
interfaces
Interface: AppViewContainer
Interface: AppViewProps
Interface: TVNode
Interface: UiViewEntry
Interface: ViewOptions
GPSVars
GPS Variables (Legacy)
Airports
Flightplans
Intersections
Miscellaneous
NDB And VOR
JavaScript
JavaScript
BaseInstruments.js
Coherent.js
Simvar.js
Communication API
Flow API
Coherent GT Debugger
Coherent Calls
CAN_FILE_WITH_ATC
FILE_ROUTE_WITH_ATC
FIND_ROUTE
GET_ATC_ROUTE
GET_EFB_ROUTE
GET_MISSION_ROUTE_LOCKS
LAUNCH_PLN_DIALOG
REPLY_TO_AVIONICS_ROUTE_REQUEST
REQUEST_AVIONICS_ROUTE
SAVE_EFB_ROUTE
SEND_ROUTE_TO_AVIONICS
SEND_ROUTE_TO_EFB
Coherent Events
AvionicsRouteRequested
AvionicsRouteRequestResponse
AvionicsRouteSync
EfbRouteFound
EfbRouteUpdated
Coherent Listeners
JS_LISTENER_AIRCRAFT_FAILURES
JS_LISTENER_AIRCRAFT_SELECTION
JS_LISTENER_AIRPORT_INFOS
JS_LISTENER_AIRPORT_SEARCH
JS_LISTENER_ATC
JS_LISTENER_AUTOPILOT
JS_LISTENER_CHECKLIST
JS_LISTENER_COMM_BUS
JS_LISTENER_COMMUNITY
JS_LISTENER_CONTENTMANAGER
JS_LISTENER_COPILOT
JS_LISTENER_DATASTORAGE
JS_LISTENER_FACILITY
JS_LISTENER_FLIGHT_BRIEFING
JS_LISTENER_FLIGHT_PLAN
JS_LISTENER_FLIGHT_STEPS
JS_LISTENER_FLIGHTOBJECT
JS_LISTENER_FLIGHTPLAN
JS_LISTENER_FUEL_PAYLOAD
JS_LISTENER_GAMEFEATURES
JS_LISTENER_GAMEFLIGHT
JS_LISTENER_GAMEVARS
JS_LISTENER_GENERICDATA
JS_LISTENER_GLOBALVARS
JS_LISTENER_INGAMEPANEL_CONTROLS
JS_LISTENER_INPUTBAR_HOLDER
JS_LISTENER_INPUTS
JS_LISTENER_INSTRUMENTS
JS_LISTENER_KEYEVENT
JS_LISTENER_LAUNCH_METHOD
JS_LISTENER_LOADING
JS_LISTENER_MAPS
JS_LISTENER_METAR
JS_LISTENER_OBJECTIVE
JS_LISTENER_OBJECTIVES
JS_LISTENER_OPTIONS_ASSISTANCES
JS_LISTENER_OPTIONS_CONTROLS
JS_LISTENER_OPTIONS_GENERALNEW
JS_LISTENER_PAUSE
JS_LISTENER_PLANNEDROUTE
JS_LISTENER_PROFANITY_FILTER
JS_LISTENER_PROFILE
JS_LISTENER_RACE_LEADERBOARD
JS_LISTENER_RENOLOBBY
JS_LISTENER_RENOMENU
JS_LISTENER_REPLAY
JS_LISTENER_SCREEN_READER
JS_LISTENER_SIMVARS
JS_LISTENER_TOOLBAR_PANELS
JS_LISTENER_TOOLTIPS
JS_LISTENER_VFRMAP
JS_LISTENER_WAIT_FOR_ROLLING_CACHE
JS_LISTENER_WASM_MODULE
JS_LISTENER_WEATHER
JS_LISTENER_WORLDMAP_FILTERS
JS_LISTENER_WORLDMAP
JS Gauge Tutorial
Setting Up For HTML-JS-CSS Instruments
Creating An HTML-JS-CSS Instrument
Replacing An HTML-JS-CSS Instrument
Debugging HTML-JS-CSS Instruments
Key Events
Key Events Index
Aircraft Autopilot And Flight Assistance Events
Aircraft Electrical Events
Aircraft Engine Events
Aircraft Flight Control Events
Aircraft Fuel System Events
Aircraft General Systems Events
Aircraft Instrumentation Events
Aircraft Miscellaneous Events
Aircraft Radio Navigation Events
Balloon And Airship Specific Events
Helicopter Specific Events
Miscellaneous Events
View And Camera Events
SimConnect
SimConnect SDK
Programming SimConnect Clients Using Managed Code
SimConnect CFG Definition
SimConnect INI Definition
SimConnect XML Definition
SimConnect API Reference
API Reference
SimConnect Actions
AI Object
AI Objects
SimConnect_AICreateEnrouteATCAircraft_EX1
SimConnect_AICreateEnrouteATCAircraft
SimConnect_AICreateNonATCAircraft_EX1
SimConnect_AICreateNonATCAircraft
SimConnect_AICreateParkedATCAircraft_EX1
SimConnect_AICreateParkedATCAircraft
SimConnect_AICreateSimulatedObject_EX1
SimConnect_AICreateSimulatedObject
SimConnect_AIReleaseControl
SimConnect_AIRemoveObject
SimConnect_AISetAircraftFlightPlan
Camera
Camera API
SimConnect_CameraAcquire
SimConnect_CameraDisableFlag
SimConnect_CameraEnableFlag
SimConnect_CameraGet
SimConnect_CameraGetStatus
SimConnect_CameraRelease
SimConnect_CameraSet
SimConnect_CameraSetUsingCameraDefinition
SimConnect_DeleteCameraWorldLocker
SimConnect_EnumerateCameraDefinitions
SimConnect_RequestCameraWorldLocker
SimConnect_SubscribeToCameraStatusUpdate
SimConnect_SubscribeToCameraWorldLockerStatusUpdate
SimConnect_UnsubscribeToCameraStatusUpdate
SimConnect_UnsubscribeToCameraWorldLockerStatusUpdate
Communication
Communication API
SimConnect_CallCommBusEvent
SimConnect_SubscribeToCommBusEvent
SimConnect_UnsubscribeToCommBusEvent
Debug
Debug
SimConnect_GetLastSentPacketID
SimConnect_InsertString
SimConnect_RequestResponseTimes
SimConnect_RetrieveString
Events And Data
Events And Data
SimConnect_AddClientEventToNotificationGroup
SimConnect_AddToClientDataDefinition
SimConnect_AddToDataDefinition
SimConnect_ClearClientDataDefinition
SimConnect_ClearDataDefinition
SimConnect_ClearNotificationGroup
SimConnect_CreateClientData
SimConnect_EnumerateSimObjectsAndLiveries
SimConnect_MapClientDataNameToID
SimConnect_MapClientEventToSimEvent
SimConnect_RemoveClientEvent
SimConnect_RequestClientData
SimConnect_RequestDataOnSimObject
SimConnect_RequestDataOnSimObjectType
SimConnect_RequestNotificationGroup
SimConnect_RequestReservedKey
SimConnect_SetClientData
SimConnect_SetDataOnSimObject
SimConnect_SubscribeToFlowEvent
SimConnect_TransmitClientEvent_EX1
SimConnect_TransmitClientEvent
SimConnect_UnsubscribeToFlowEvent
Facilities
Facilities
SimConnect_AddFacilityDataDefinitionFilter
SimConnect_AddToFacilityDefinition
SimConnect_ClearAllFacilityDataDefinitionFilters
SimConnect_RequestAllFacilities
SimConnect_RequestFacilitesList
SimConnect_RequestFacilitiesList_EX1
SimConnect_RequestFacilityData_EX1
SimConnect_RequestFacilityData
SimConnect_RequestJetwayData
SimConnect_SubscribeToFacilities_EX1
SimConnect_SubscribeToFacilities
SimConnect_UnsubscribeToFacilities_EX1
SimConnect_UnsubscribeToFacilities
Flights
Flights
SimConnect_FlightLoad
SimConnect_FlightPlanLoad
SimConnect_FlightSave
General
DispatchProc
General
SimConnect_CallDispatch
SimConnect_Close
SimConnect_ExecuteAction
SimConnect_GetNextDispatch
SimConnect_Open
SimConnect_RequestSystemState
SimConnect_SetNotificationGroupPriority
SimConnect_SetSystemEventState
SimConnect_SubscribeToSystemEvent
SimConnect_UnsubscribeFromSystemEvent
InputEvents
Input Events
SimConnect_ClearInputGroup
SimConnect_EnumerateControllers
SimConnect_EnumerateInputEventParams
SimConnect_EnumerateInputEvents
SimConnect_GetInputEvent
SimConnect_MapInputEventToClientEvent_EX1
SimConnect_MapInputEventToClientEvent
SimConnect_RemoveInputEvent
SimConnect_SetInputEvent
SimConnect_SetInputGroupPriority
SimConnect_SetInputGroupState
SimConnect_SubscribeInputEvent
SimConnect_UnsubscribeInputEvent
Structures And Enumerations
SIMCONNECT_CAMERA_AVAILABILITY
SIMCONNECT_CAMERA_DATA_MASK
SIMCONNECT_CAMERA_DEFINITION_ITEM
SIMCONNECT_CAMERA_FLAG
SIMCONNECT_CAMERA_WORLD_LOCKER_STATUS
SIMCONNECT_CLIENT_DATA_PERIOD
SIMCONNECT_COMM_BUS_BROADCAST_TO
SIMCONNECT_CONTROLLER_ITEM
SIMCONNECT_DATA_CAMERA
SIMCONNECT_DATA_FACILITY_AIRPORT
SIMCONNECT_DATA_FACILITY_NDB
SIMCONNECT_DATA_FACILITY_VOR
SIMCONNECT_DATA_FACILITY_WAYPOINT
SIMCONNECT_DATA_INITPOSITION
SIMCONNECT_DATA_LATLONALT
SIMCONNECT_DATA_MARKERSTATE
SIMCONNECT_DATA_PBH
SIMCONNECT_DATA_RACE_RESULT
SIMCONNECT_DATA_WAYPOINT
SIMCONNECT_DATA_XYZ
SIMCONNECT_DATATYPE
SIMCONNECT_ENUMERATE_SIMOBJECT_LIVERY
SIMCONNECT_EXCEPTION
SIMCONNECT_FACILITY_DATA_TYPE
SIMCONNECT_FACILITY_LIST_TYPE
SIMCONNECT_FACILITY_MINIMAL
SIMCONNECT_FLOW_EVENT
SIMCONNECT_ICAO
SIMCONNECT_INPUT_EVENT_DESCRIPTOR
SIMCONNECT_INPUT_EVENT_TYPE
SIMCONNECT_JETWAY_DATA
SIMCONNECT_MISSION_END
SIMCONNECT_PERIOD
SIMCONNECT_POSITION_REFERENTIAL
SIMCONNECT_RECV_AIRPORT_LIST
SIMCONNECT_RECV_ASSIGNED_OBJECT_ID
SIMCONNECT_RECV_CAMERA_DATA
SIMCONNECT_RECV_CAMERA_DEFINITION_LIST
SIMCONNECT_RECV_CAMERA_STATUS
SIMCONNECT_RECV_CAMERA_WORLD_LOCKER
SIMCONNECT_RECV_CLIENT_DATA
SIMCONNECT_RECV_COMM_BUS
SIMCONNECT_RECV_CONTROLLERS_LIST
SIMCONNECT_RECV_ENUMERATE_INPUT_EVENT_PARAMS
SIMCONNECT_RECV_ENUMERATE_INPUT_EVENTS
SIMCONNECT_RECV_ENUMERATE_SIMOBJECT_AND_LIVERY_LIST
SIMCONNECT_RECV_EVENT_EX1
SIMCONNECT_RECV_EVENT_FILENAME
SIMCONNECT_RECV_EVENT_FRAME
SIMCONNECT_RECV_EVENT_MULTIPLAYER_CLIENT_STARTED
SIMCONNECT_RECV_EVENT_MULTIPLAYER_SERVER_STARTED
SIMCONNECT_RECV_EVENT_MULTIPLAYER_SESSION_ENDED
SIMCONNECT_RECV_EVENT_OBJECT_ADDREMOVE
SIMCONNECT_RECV_EVENT_RACE_END
SIMCONNECT_RECV_EVENT_RACE_LAP
SIMCONNECT_RECV_EVENT
SIMCONNECT_RECV_EXCEPTION
SIMCONNECT_RECV_FACILITIES_LIST
SIMCONNECT_RECV_FACILITY_DATA_END
SIMCONNECT_RECV_FACILITY_DATA
SIMCONNECT_RECV_FACILITY_MINIMAL_LIST
SIMCONNECT_RECV_FLOW_EVENT
SIMCONNECT_RECV_GET_INPUT_EVENT
SIMCONNECT_RECV_ID
SIMCONNECT_RECV_JETWAY_DATA
SIMCONNECT_RECV_LIST_TEMPLATE
SIMCONNECT_RECV_NDB_LIST
SIMCONNECT_RECV_OPEN
SIMCONNECT_RECV_QUIT
SIMCONNECT_RECV_RESERVED_KEY
SIMCONNECT_RECV_SIMOBJECT_DATA_BYTYPE
SIMCONNECT_RECV_SIMOBJECT_DATA
SIMCONNECT_RECV_SUBSCRIBE_INPUT_EVENT
SIMCONNECT_RECV_SYSTEM_STATE
SIMCONNECT_RECV_VOR_LIST
SIMCONNECT_RECV_WAYPOINT_LIST
SIMCONNECT_RECV
SIMCONNECT_SIMOBJECT_TYPE
SIMCONNECT_STATE
SIMCONNECT_VERSION_BASE_TYPE
SIMCONNECT_WAYPOINT_FLAGS
Structs And Enums
SimVars
Simulation Variables
Simulation Variable Units
Balloon And Airship Variables
Camera Variables
Helicopter Variables
Miscellaneous Variables
Services Variables
Aircraft SimVars
Aircraft Autopilot And Assistant Variables
Aircraft Brake And Landing Gear Variables
Aircraft Control Variables
Aircraft Electrics Variables
Aircraft Engine Variables
Aircraft Flight Model Variables
Aircraft Fuel Variables
Aircraft Miscellaneous Variables
Aircraft Radio Navigation Variables
Aircraft System Variables
WASM
WebAssembly
Core And Helpers
Update Callbacks
GDI+
Creating A WASM Project
Creating WASM Gauges
Creating WASM Systems
Creating WASM Airports
Debugging WebAssembly Modules
VS WASM Debugger Extension
Camera API
Camera API
FsAcquiredState
fsCameraAcquire
FsCameraData
FsCameraDataMask
fsCameraDeleteCameraWorldLocker
fsCameraDisableFlag
fsCameraEnableFlag
fsCameraEnumerateCameraDefinitions
FsCameraEvent
FsCameraFlag
fsCameraGet
fsCameraGetStatus
fsCameraRelease
fsCameraRequestCameraWorldLocker
fsCameraSet
fsCameraSetUsingCameraDefinition
fsCameraSubscribeToCameraWorldLockerStatusUpdate
fsCameraSubscribeToStatusUpdate
fsCameraUnsubscribeToCameraWorldLockerStatusUpdate
fsCameraUnsubscribeToStatusUpdate
FsCameraWorldLockerStatus
FsPositionReferential
Charts API
Charts API
FsChartArea
FsChartError
FsChartGeoReferenceLambertConformalConicProjection
FsChartIndex
FsChartIndexCategory
FsChartMetadata
FsChartPage
FsChartPages
FsChartPageUrl
FsChartProcedureIdentifier
FsChartProcedureIdentifierType
FsChartRectangle
FsChartRelationship
FsChartRelationshipType
fsChartsFreeChartIndex
fsChartsFreeChartPages
fsChartsGetIndex
fsChartsGetPageImage
fsChartsGetPages
Communication API
Communication API
FsCommBusBroadcastFlags
fsCommBusCall
fsCommBusRegister
fsCommBusUnregister
fsCommBusUnregisterAll
fsCommBusUnregisterOneEvent
Event API
Event API
FsEventsError
fsEventsHEventCall
fsEventsRegisterHEvent
fsEventsRegisterKeyEventHandler
fsEventsUnregisterKeyEventHandler
fsEventsTriggerKeyEvent
Flow API
Flow API
FsFlowEvent
fsFlowRegister
fsFlowUnregister
fsFlowUnregisterAll
Gauge API
Gauge API
Functions
aircraft_varget
check_named_variable
execute_calculator_code
format_calculator_string
gauge_calculator_code_precompile
get_aircraft_var_enum
get_gauge_flags
get_name_of_named_variable
get_named_variable_typed_value
get_named_variable_value
get_units_enum
initialize_var_by_name
initialize_var
lookup_var
register_key_event_handler_EX1
register_key_event_handler
register_named_variable
register_var_by_name
send_key_event
set_gauge_flags
set_named_variable_typed_value
set_named_variable_value
trigger_key_event_EX1
trigger_key_event
unregister_all_named_vars
unregister_key_event_handler_EX1
unregister_key_event_handler
unregister_var_by_name
Token Vars
Autopilot
Electrics
Engines
Fuel
Gear And Hydraulics
General Aircraft
General Simulation
Helicopters
Radio Navigation
Surfaces
Token Variables
Vehicles
Warnings And Failures
IO API
fsIOClose
FsIOErr
fsIOGetFileSize
fsIOGetLastError
fsIOHasError
fsIOInProgress
fsIOIsDone
fsIOIsOpen
fsIOOpen
FsIOOpenFlags
fsIOOpenRead
fsIORead
fsIOWrite
IO API
Low Level API
NanoVG API
Functions
fsRenderCancel
fsRenderClearStencil
fsRenderCreate
fsRenderCreateTexture
fsRenderDelete
fsRenderDeleteTexture
fsRenderFill
fsRenderFlush
fsRenderGetTextureSize
fsRenderStroke
fsRenderTriangles
fsRenderUpdateTexture
fsRenderViewport
Structures
FsColor
FsCompositeOperation
FsPaint
FsPath
FsScissor
FsVertex
MapView API
fsMapViewCreate
fsMapViewDelete
fsMapViewSet2DViewFollowMode
fsMapViewSet2DViewLatLong
fsMapViewSet2DViewRadiusInMeters
fsMapViewSet3D
fsMapViewSet3DCustomViewOrientationInRadians
fsMapViewSet3DViewOrientation
fsMapViewSetAltitudeColorList
fsMapViewSetAltitudeRangeInFeet
fsMapViewSetAltitudeReference
fsMapViewSetBackgroundColor
fsMapViewSetMapIsolinesVisibility
fsMapViewSetSize
fsMapViewSetViewMode
fsMapViewSetVisibility
fsMapViewSetWeatherRadarBankLimitsInRadians
fsMapViewSetWeatherRadarConeAngleInRadians
fsMapViewSetWeatherRadarMode
fsMapViewSetWeatherRadarPitchLimitsInRadians
fsMapViewSetWeatherRadarRainColors
fsMapViewSetWeatherRadarScanRate
fsMapViewSetWeatherRadarStabilization
fsMapViewSetWeatherRadarTiltInRadians
fsMapViewSetWeatherRadarVisibility
MapView API
Network API
fsNetworkHttpCancelRequest
fsNetworkHttpRequestGet
fsNetworkHttpRequestGetData
fsNetworkHttpRequestGetDataSize
fsNetworkHttpRequestGetErrorCode
fsNetworkHttpRequestGetHeaderSection
fsNetworkHttpRequestGetState
FsNetworkHttpRequestParam
fsNetworkHttpRequestPOST
fsNetworkHttpRequestPut
FsNetworkHttpRequestState
Network API
Planned Route API
fsPlannedRouteGetEfbRoute
fsPlannedRouteRegisterForBroadcast
fsPlannedRouteRegisterForRequest
fsPlannedRouteRespondToRequest
fsPlannedRouteUnregisterForBroadcast
fsPlannedRouteUnregisterForRequest
Planned Route API
Vars API
fsVarsAircraftVarGet
fsVarsAircraftVarSet
fsVarsAVarBufferGet
fsVarsAVarBufferSet
fsVarsAVarGet
fsVarsAVarSet
fsVarsAVarXYZGet
fsVarsAVarXYZSet
fsVarsBVarCall
fsVarsBVarGet
fsVarsBVarStringGet
fsVarsCustomSimdVarGet
fsVarsCustomSimVarSet
fsVarsEnvironmentVarGet
fsVarsEVarGet
fsVarsGetAircraftVarId
fsVarsGetAVarId
fsVarsGetBVarId
fsVarsGetEnvironmentVarId
fsVarsGetEVarId
fsVarsGetIVarId
fsVarsGetLVarId
fsVarsGetLVarName
fsVarsGetOVarId
fsVarsGetRegisteredNamedVarId
fsVarsGetUnitId
fsVarsGetZVarId
fsVarsIVarGet
fsVarsIVarSet
fsVarsLVarGet
fsVarsLVarSet
fsVarsNamedVarGet
fsVarsNamedVarSet
fsVarsOVarGet
fsVarsOVarSet
fsVarsRegisterCustomSimVar
fsVarsRegisterIVar
fsVarsRegisterLVar
fsVarsRegisterNamedVar
fsVarsRegisterOVar
fsVarsRegisterVarsStatusUpdateHandler
fsVarsRegisterZVar
fsVarsUnregisterAllVarsStatusUpdateHandler
fsVarsUnregisterVarsStatusUpdateHandler
fsVarsZVarGet
fsVarsZVarSet
Vars API
VFX API
fsVfxDestroyInstance
fsVfxIsInstancePlaying
fsVfxIsMinTimePassed
fsVfxIsValid
fsVfxPlayInstance
fsVfxSetOffset
fsVfxSetRotation
fsVfxSetWorldPosition
fsVfxSpawnInWorld
fsVfxSpawnOnSimObject
fsVfxStopInstance
VFX API
Samples Tutorials
Samples, Tutorials and Primers
Samples
SimObjects Aircraft
DA62
DA62 Mod
Cabri G2
SimpleAircraft
WASMAircraft
ModularAircraft
CameraAircraft
ChartsAircraft
CommBusAircraft
FlowAircraft
GaugeAircraft
GaugeAndSystemsAircraft
GdiplusAircraft
IOAircraft
MapViewAircraft
MouseAircraft
NetworkAircraft
PlannedRouteAircraft
SoundAircraft
VarsAndEventsAircraft
VFXAircraft
SimObjects Other
AirportVehiclesSample
BearsSampleProject
Jetway
WindsockSample
Sceneries
AirportKALO
AirportLFPG2024
AirportServices
LivingWorld
SimpleAerial
SimpleAirport
SimpleBiomes
SimpleNavData
SimpleProjectedMesh
SimpleScenery
SimpleWasmAirport
SimplygonSimpleScene
EFB
EFB Template Sample
Misc
InputProfiles
SimpleFX
StandaloneModule
TrafficVehiclesSample
VisualStudio
PackageInstaller
SimConnect Samples
SimvarWatcher
Tutorials
Aircraft Checklist
Aircraft Creation Workflow
Preparation
Creating A Modular Aircraft Project
Building An Aircraft Package
Additional Aircraft Information
Tuning The Flight Model
Tuning The Flight Model
Basic Aerodynamics
Geometry
Aircraft Geometry
Fuesalge Geometry
Wing Geometry
Tail Geometry
Other Surface Geometry
Wheels And Contact Points
Weight And Balance
Engines
Tuning Engines
Piston Engines
Turbine Engines
Engine Fine Tuning
Electrical Systems
Fuel System
Fine Tuning
Testing The Aircraft
Creating Or Replacing An Airport
Primers
Flight Model Physics Primer
PID Primer
SDK Tools
SDK Tools
Package Tool
Package Tool
Components And Concepts
Package Tool XML Properties
BGL Explorer
Content Creator Testing Tool
FS DevMode Launcher
MSFS Turbojet Static Performance Tool
VS Code Extension
On this page
On this page
Home
Retail
Programming APIs
JavaScript
Coherent Listeners
JS_LISTENER_COPILOT
JS_LISTENER_COPILOT
NOTE
This page is currently a
Work In Progress
.
Call
Parameters
Description
Prev
JS_LISTENER_CONTENTMANAGER
Next
JS_LISTENER_DATASTORAGE
Report An Issue
Please explain the issue:
0/255
Send
Cancel
