Microsoft Flight Simulator 2024 SDK

https://docs.flightsimulator.com/msfs2024/html/
Admin
Official software development kit (SDK) documentation for creating add-ons, aircraft, scenery, and...
Tokens:2,775,880
Snippets:16,471
Trust Score:9.7
Update:1 week ago
Show doc for...
Tokens:
Raw
### GUID element example

Source: https://docs.flightsimulator.com/msfs2024/html/5_Content_Configuration/Environment/SimProp_Containers/SimPropContainer_XML_Properties.htm

Example of the GUID element, used to give a GUID to the SimPropContainer object/instance or included object. This GUID is referenced in other files for missions and scenery.

```xml
<GUID>{FDE1EC0B-7021-45E9-AC3B-066E307B4979}</GUID>
```

--------------------------------

### Initial File Setup for Cockpit Interactions

Source: https://docs.flightsimulator.com/msfs2024/html/5_Content_Configuration/Models/ModelBehaviors/UsingBehaviours/Interactions/Creating_Cockpit_Interactions.htm?tocid=6_2_3

Initial setup for a cockpit interaction model behavior file. Start with the top-level <ModelBehaviors> element, then include the core template file ASOBO_EX1\InteriorDefs.xml, and finally add a <Component ID="CONFIG"> that calls ASOBO_Configure_Global_Parameters to initialize required global parameters. The file should not contain LOD data; that is handled by the main model XML file.

```xml
<ModelBehaviors>
    <!-- Everything Else Here -->
</ModelBehaviors>
```

```xml
<ModelBehaviors>
    <Include ModelBehaviorFile="ASOBO_EX1\InteriorDefs.xml"/>
</ModelBehaviors>
```

```xml
<ModelBehaviors>
    <Include ModelBehaviorFile="ASOBO_EX1\InteriorDefs.xml"/>
    <Component ID="CONFIG">
        <Parameters Type="Override">
            <UseParametersFn Name="ASOBO_Configure_Global_Parameters"/>
        </Parameters>
    </Component>
    <!-- Future Components Here -->
</ModelBehaviors>
```

--------------------------------

### Example: spawning a VFX in the world

Source: https://docs.flightsimulator.com/msfs2024/html/6_Programming_APIs/WASM/VFX_API/fsVfxSpawnInWorld.htm

Example usage of fsVfxSpawnInWorld. It sets up a position, pitch/bank/heading, and graph parameters for color, then spawns the VFX and stores the returned ID. The VFX starts playing automatically and should be destroyed with fsVfxDestroyInstance when no longer needed.

```cpp
FsVec3d lla = { 36.151591, -5.340841, 58.154 };
FsVec3d pbh = { 0, 0, 0 };
FsVfxGraphParam graphParams[3];
graphParams[0].paramName = "ColorR";
graphParams[0].RPNExpression = "0";
graphParams[1].paramName = "ColorG";
graphParams[1].RPNExpression = "0";
graphParams[2].paramName = "ColorB";
graphParams[2].RPNExpression = "1";
g_SpawnVars.fxInWorldId = fsVfxSpawnInWorld("AAF9ECBE-C092-429A-877B-D41357D1E519", lla, pbh, -1, graphParams, 3);
```

--------------------------------

### ApronContextReference example

Source: https://docs.flightsimulator.com/msfs2024/html/5_Content_Configuration/Environment/Airports_And_Facilities/Apron_Services/Apron_Services_XML_Properties.htm

Self-closing element to get a reference to a SimObject from the current Apron Control request context. The InstanceId is a GUID enclosed in braces, and ApronReferenceType can be ApronControl, Aircraft, Context, Jetway, Mission, or Vehicle.

```XML
<ApronControl.ApronContextReference id="Aircraft" InstanceId="{5C4F5800-E9BC-4445-9EEF-1571458FDF9D}" ApronReferenceType="Aircraft" />
```

--------------------------------

### Full SoundInfo XML Example with Engine Sounds

Source: https://docs.flightsimulator.com/msfs2024/html/4_Sound/Aircraft_Audio/Advanced_Sound_xml.htm

Complete example of a SoundInfo XML file with WwisePackages, AcousticParameters, EngineSoundPresets, and MiscellaneousSound. Includes engine sounds for Combustion, Propeller, Starter, CombustionStart, and Shutdown.

```xml
<?xml version="1.0" encoding="utf-8" ?>
<SoundInfo Version="0.1">
    <WwisePackages>
        <MainPackage Name="MyCompany_TestAircraft">
    </WwisePackages>
    <AcousticParameters>
        <Parameter Name="ReverberationPreset" ShareSetInside="rev_inside_MyCompany_TestAaircraft" ShareSetOutside="rev_outdoor_MyCompany_TestAircraft" />
    </AcousticParameters>
    <EngineSoundPresets>
        <Sound WwiseEvent="Combustion" ConeHeading="180" FadeOutType="2" FadeOutTime="0.2" RPMMin="200" WwiseData="True" EngineIndex="1" />
        <Sound WwiseEvent="Propeller" ConeHeading="0" FadeOutType="2" FadeOutTime="0.2" RPMMin="200" WwiseData="True" EngineIndex="1" />
        <Sound WwiseEvent="Starter" FadeOutType="2" FadeOutTime="0.2" WwiseData="True" EngineIndex="1" />
        <Sound WwiseEvent="CombustionStart" FadeOutType="2" FadeOutTime="0.2" WwiseData="True" EngineIndex="1" />
        <Sound WwiseEvent="Shutdown" FadeOutType="2" FadeOutTime="0.2" RPMMin="200" WwiseData="True" EngineIndex="1" />
  </EngineSoundPresets>
    <MiscellaneousSound>
        <Sound WwiseEvent="STALL_WARNING" WwiseData="true" />
    </MiscellaneousSound>
</SoundInfo>
```

--------------------------------

### fsVarsAVarBufferSet Example

Source: https://docs.flightsimulator.com/msfs2024/html/6_Programming_APIs/WASM/Vars_API/fsVarsAVarBufferSet.htm

Example usage of the Vars API to get a unit ID and AVar ID, then use fsVarsAVarBufferGet to retrieve a value into a buffer. Note: the example uses Get, not Set, despite the page title.

```c
FsUnitId unitId = fsVarsGetUnitId("String");
FsAVarId aVarId = fsVarsGetAVarId("ATC AIRLINE");
char buffer[128];
buffer[0] = '\0';
if (fsVarsAVarBufferGet(aVarId, unitId, {}, buffer, sizeof(buffer)) == FS_VAR_ERROR_NONE)
{
    // valid
}
else
{
    // error
}
```

--------------------------------

### Override element example

Source: https://docs.flightsimulator.com/msfs2024/html/5_Content_Configuration/Environment/SimProp_Containers/SimPropContainer_XML_Properties.htm

Example of the Override element, used to override the current SimProp Container with another one identified by its GUID. Requires a GUID sub-element.

```xml
<Override>
    <GUID>"{C382BACA-32F5-4EFF-88D1-73688CCD7EFC}"</GUID>
</Override>
```

--------------------------------

### WwisePackages definition example

Source: https://docs.flightsimulator.com/msfs2024/html/5_Content_Configuration/Sounds/Sound_XML_Examples.htm

Shows how to define Wwise packages at the start of the XML. If omitted, the package name is deduced from the sound.xml file path.

```xml
<WwisePackages>
    <MainPackage Name="MyCompany_MyAircraft"/>
    <AdditionalPackage Name="MyCompany_MyAircraft_Additional1"/>
    <AdditionalPackage Name="MyCompany_MyAircraft_Additional2"/>
</WwisePackages>
```

--------------------------------

### ASOBO_material_clear_coat_v2 schema example

Source: https://docs.flightsimulator.com/msfs2024/html/3_Models_And_Textures/Plugins/glTF_Schemas.htm?agt=index

Describes ClearCoat material parameters. The example sets clearcoatRoughnessFactor, clearcoatNormalFactor, and clearcoatColorNormalTiling.

```json
"ASOBO_material_clear_coat_v2": {
    "clearcoatRoughnessFactor": 0.25,
									    "clearcoatNormalFactor": 0.5,
									    "clearcoatColorNormalTiling": 2.0
}
```

--------------------------------

### initialize_var Example

Source: https://docs.flightsimulator.com/msfs2024/html/6_Programming_APIs/WASM/Gauge_API/Functions/initialize_var.htm

Example usage of initialize_var, initializing a MODULE_VAR variable within an install routine.

```c
MODULE_VAR gs_var = {VOR1_GS_FLAG}; 
    void install_routine(HINSTANCE resource_file_handle) 
    { 
        initialize_var(&gs_var);
        'Include other initialization code. 
    } 
```

--------------------------------

### Example usage of fsVarsEnvironmentVarGet

Source: https://docs.flightsimulator.com/msfs2024/html/6_Programming_APIs/WASM/Vars_API/fsVarsEnvironmentVarGet.htm

Example showing how to get the value of the 'ZULU TIME' EVar using fsVarsEnvironmentVarGet. It retrieves the unit ID for 'seconds', gets the EVar ID, and checks the return value for success.

```c
FsUnitId unitId = fsVarsGetUnitId("seconds");
FsEnvVarId eVarId = fsVarsGetEVarId("ZULU TIME");
double result = 0;
if (fsVarsEnvironmentVarGet(eVarId, unitId, &result) == FS_VAR_ERROR_NONE)
{
    // valid
}
else
{
    // error
}
```

--------------------------------

### Configure Shared Preflight Audio with Asobo_Preflight and SimVarSounds

Source: https://docs.flightsimulator.com/msfs2024/html/5_Content_Configuration/Careers/General_Career_Information/Preflight.htm

Reference the shared Asobo_Preflight audio package in a sound XML file, then add a SimVarSounds section that lists Wwise events tied to the COVER ON SimVar. Each Sound element assigns a WwiseEvent to an Index and triggers when COVER ON becomes 0 (Downward=true).

```xml
<?xml version="1.0" encoding="utf-8"?>
<SoundInfo Version="0.1">
    <WwisePackages>
        <SharedPackage Name="Asobo_Preflight"/>
    </WwisePackages>
</SoundInfo>
```

```xml
<SimVarSounds>
    <Sound WwiseData="true" WwiseEvent="wheel_chock_type_1" SharedPackageName="Asobo_Preflight" Continuous="false" SimVar="COVER ON" Units="BOOLEAN" Index="0">
        <TriggerValue Value="0" Downward="true"/>
    </Sound>
    <Sound WwiseData="true" WwiseEvent="engine_cover_type_2" SharedPackageName="Asobo_Preflight" Continuous="false" SimVar="COVER ON" Units="BOOLEAN" Index="1">
        <TriggerValue Value="0" Downward="true"/>
    </Sound>
    <Sound WwiseData="true" WwiseEvent="pitot_cover_type_1" SharedPackageName="Asobo_Preflight" Continuous="false" SimVar="COVER ON" Units="BOOLEAN" Index="2">
        <TriggerValue Value="0" Downward="true"/>
    </Sound>
    <Sound WwiseData="true" WwiseEvent="static_port_cover_type_1" SharedPackageName="Asobo_Preflight" Continuous="false" SimVar="COVER ON" Units="BOOLEAN" Index="3">
        <TriggerValue Value="0" Downward="true"/>
    </Sound>
    <Sound WwiseData="true" WwiseEvent="antenna_cover_type_1" SharedPackageName="Asobo_Preflight" Continuous="false" SimVar="COVER ON" Units="BOOLEAN" Index="5">
        <TriggerValue Value="0" Downward="true"/>
    </Sound>
</SimVarSounds>
```

--------------------------------

### fsVarsOVarSet Example

Source: https://docs.flightsimulator.com/msfs2024/html/6_Programming_APIs/WASM/Vars_API/fsVarsOVarSet.htm

Example usage of fsVarsOVarSet. It registers an OVar, gets a unit ID, sets the value, and checks for errors.

```c
FsUnitId unitId = fsVarsGetUnitId("DEGREES");
FsOVarId oVarId = fsVarsRegisterOVar("Toto", "LIGHTING:EMISSIVE");
double value = 8;
if (fsVarsOVarSet(oVarId, unitId, value) == FS_VAR_ERROR_NONE)
{
    // valid
}
else
{
    // error
}
```

--------------------------------

### SimConnect.ini Configuration Example

Source: https://docs.flightsimulator.com/msfs2024/html/assets/Files/SimConnect/SimConnect.ini

Example configuration for SimConnect.ini. Sets verbose logging, enables a console window, and writes logs to c:\logs\simconnect%03u.log. The target folder must exist and not be protected.

```ini
[SimConnect]

;; Set the level of text communication to be provided to the console, debug  string, or log file
;; level = {Verbose, Normal, Warning, Error, Off}, default = Off
level=verbose

;; Open a command line debug window to display server to client 
;; console = {1 (on), 0 (off)} , default = Off
console=1 

;; Use std console instead of dedicated one
;; RedirectStdOutToConsole = {1 (on), 0 (off)} , default = Off
;RedirectStdOutToConsole=1

;; Sends the output text to the Platform SDK OutputDebugString. Refer to MSDN  documentation for more
;; OutputDebugString = {1 (on), 0 (off)} , default = Off
;OutputDebugString=1

;; file = {path}, optional %03u for incremental naming , default = not writing to file
;; important: the target folder needs to exist, and not to be protected
file=c:\logs\simconnect%03u.log

;; incremental naming parameters
;; The index of the first log file. Subsequent log files will have the index  number incremented by one. 
;file_next_index=0
```

--------------------------------

### fsVarsNamedVarGet Example

Source: https://docs.flightsimulator.com/msfs2024/html/6_Programming_APIs/WASM/Vars_API/fsVarsNamedVarGe.htm

Example usage of fsVarsNamedVarGet. It gets a unit ID, registers a named var, and retrieves its value, checking for errors.

```c
FsUnitId unitId = fsVarsGetUnitId("DEGREES");
FsNamedVarId namedId = fsVarsRegisterNamedVar("TOTO");
double result = 0;
if (fsVarsNamedVarGet(namedId , unitId, &result) == FS_VAR_ERROR_NONE)
{
    // valid
}
else
{
    // error
}
```

--------------------------------

### Using ASOBO_CT_Switch_Template with GET_SETTINGS

Source: https://docs.flightsimulator.com/msfs2024/html/5_Content_Configuration/Models/ModelBehaviors/UsingBehaviours/Interactions/Creating_Cockpit_Interactions.htm?tocid=6_2_0_6_4_0

Example of using the ASOBO_CT_Switch_Template template with a GET_SETTINGS parameter to define discrete state interactions. The GET_SETTINGS references a ParametersFn that defines the positions.

```XML
<UseTemplate Name="ASOBO_CT_Switch_Template">
    <IN_BASE_NAME>OVHD_BELTS_SWITCH_FASTEN_1</IN_BASE_NAME>
    <IE_NAME>FASTEN_BELTS</IE_NAME>
    <GET_SETTINGS>MYFUNCTION_ON_AUTO_OFF_Settings</GET_SETTINGS>
    <SOUND_EVENT_TYPE_ID>1</SOUND_EVENT_TYPE_ID>
</UseTemplate>
```

--------------------------------

### fsVfxPlayInstance

Source: https://docs.flightsimulator.com/msfs2024/html/6_Programming_APIs/WASM/VFX_API/VFX_API.htm

Starts a VFX instance playing.

```APIDOC
## fsVfxPlayInstance

### Description
Starts a VFX instance playing.

### Function Signature
`fsVfxPlayInstance`

### Parameters
- **VFX instance ID** (type: FsVfxId) - Required - The ID of the VFX instance to play.
```
Tokens:
Raw