Microsoft Flight Simulator Software Development Kit

https://docs.flightsimulator.com/html/
Admin
The Microsoft Flight Simulator Software Development Kit (SDK) provides comprehensive tools and...
Tokens:2,160,527
Snippets:18,547
Trust Score:9.7
Update:5 months ago
Show doc for...
Tokens:
Raw
### While Loop Setup Example

Source: https://docs.flightsimulator.com/html/Content_Configuration/Models/ModelBehaviors/Program_Template_Definitions.htm

This example demonstrates the setup for a 'while' loop. It increments a parameter 'ID' as long as a generated parameter remains valid. Note the iteration limit of 64 unless a '<To>' element is also specified.

```XML
<Setup>
    <Param>ID</Param>
    <From>1</From>
    <Inc>1</Inc>
    <While>
        <Arg Valid="MY_PARAM_#ID#"/>
    </While>
</Setup>
```

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

### Example Visual Effect Spawner Configuration

Source: https://docs.flightsimulator.com/html/Content_Configuration/VisualEffects/Visual_Effects.htm

An example demonstrating how to configure a visual effect spawner with specific parameters like GUID, spawn code, contact point, and offsets.

```XML
<Component ID="MyVFXSpawner">
    <Parameters Type="Override">
        <FX_GUID>{7E68323C-E75D-4F5B-988E-65DD4956F6BA}</FX_GUID>
        <!-- Always spawn -->
        <FX_CODE>1 0 &gt;</FX_CODE>
        <!-- Spawn on contact point 2 if node not found -->
        <FX_CONTACT_POINT_ID>2</FX_CONTACT_POINT_ID>
        <!-- Offset effect instances up 1 meter -->
        <FX_OFFSET_Y>1.0</FX_OFFSET_Y>
        <!-- Pitch effect instances 90 degrees -->
        <FX_ROTATION_OFFSET_P>90.0</FX_ROTATION_OFFSET_P>
    </Parameters>
</Component>
```

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

### Real-World Key Event Examples

Source: https://docs.flightsimulator.com/html/Programming_Tools/SimVars/Simulation_Variables.htm

Examples demonstrating how to trigger key events with one or two parameters.

```RPN
1 (>K:TOGGLE_EXTERNAL_POWER)
```

```RPN
50 1 (>K:2:PANEL_LIGHTS_POWER_SETTING_SET)
```

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

### Advanced Checkpoint Example with Shared Variables

Source: https://docs.flightsimulator.com/html/Content_Configuration/Checklists/Checklist_Examples.htm

This example demonstrates a complex checkpoint setup using shared variables to control conditional execution of sequences. It initializes variables and uses them to ensure only one of two possible sequences is triggered based on simulator state.

```xml
<Checkpoint Id="Magneto_150_RPM_Max_Decrease">
    <CheckpointDesc SubjectTT="TT:GAME.CHECKLIST_MAGNETOS" ExpectationTT="TT:GAME.CHECKLIST_150RPM_MAX_DECREASE"/>
    <Action Condition="Init" StoreVar="Magneto_RPM_BOTH" Value="0"/>
    <Action Condition="Init" StoreVar="Magneto_RPM_LEFT" Value="0"/>
    <Action Condition="Init" StoreVar="Magneto_RPM_RIGHT" Value="0"/>
    <Sequence SeqType="Ordered">
        <Test>
            <TestValue>
                <Operator OpType="And">
                    <Val SimVarName="RECIP ENG LEFT MAGNETO:1" Units="Boolean"/>
                    <Val SimVarName="RECIP ENG RIGHT MAGNETO:1" Units="Boolean"/>
                </Operator>
            </TestValue>
            <Duration Value="1.0" Cumulative="False"/>
            <Once>True</Once>
            <Instrument id="MAGNETO"/>
            <Action Copilot="True" Condition="TestValueFalse" Once="true" EventID="MAGNETO_BOTH"/>
            <Action Condition="TestValueTrue" Once="false" StoreVar="Magneto_RPM_BOTH">
                <Val SimVarName="GENERAL ENG RPM:1" Units="rpm"/>
            </Action>
        </Test>
      
        <Sequence SeqType="Unordered">
            <Sequence SeqType="Ordered">
                <Once>True</Once>
                <Test>
                    <TestValue>
                        <Operator OpType="OR"> <!-- Skips if Magneto_RPM_RIGHT is already set -->
                            <Val ReadVar="Magneto_RPM_RIGHT"/>
                            <Operator OpType="And">
                                <Val SimVarName="RECIP ENG LEFT MAGNETO:1" Units="Boolean"/>
                                <Operator OpType="Not">
                                    <Val SimVarName="RECIP ENG RIGHT MAGNETO:1" Units="Boolean"/>
                                </Operator>
                            </Operator>
                        </Operator>
                    </TestValue>
                    <Duration Value="1.5" Cumulative="False"/>
                    <Instrument id="MAGNETO"/>
                    <Action Copilot="True" Condition="TestValueFalse" Once="true" EventID="MAGNETO_LEFT"/>
                </Test>
                <Test>
                    <TestValue>
                        <Operator OpType="OR"> <!-- Skips if Magneto_RPM_RIGHT is already set -->
                            <Val ReadVar="Magneto_RPM_RIGHT"/>
                            <Operator OpType="Greater">
                                <Val SimVarName="GENERAL ENG RPM:1" Units="rpm"/>
                                <Operator OpType="Minus">
                                    <Val ReadVar="Magneto_RPM_BOTH"/>
                                    <Val Value="150"/>
                                </Operator>
                            </Operator>
                        </Operator>
                    </TestValue>
                </Test>
                <Test> <!-- Store the current rpm in Magneto_RPM_LEFT, unless Magneto_RPM_RIGHT is already set -->
                    <TestValue>
                        <Operator OpType="OR"> <!-- Verifies if one of the var is set -->
                            <Val ReadVar="Magneto_RPM_LEFT"/>
                            <Val ReadVar="Magneto_RPM_RIGHT"/>
                        </Operator>
                    </TestValue>
                    <Action Condition="TestValueFalse" Once="True" StoreVar="Magneto_RPM_LEFT">
                        <Val SimVarName="GENERAL ENG RPM:1" Units="rpm"/>
                    </Action>
                </Test>
           </Sequence>
 
           <Sequence SeqType="Ordered">
                <Once>True</Once>
                <Test>
                    <TestValue>
                        <Operator OpType="OR"> <!-- Skips if Magneto_RPM_LEFT is already set -->
                            <Val ReadVar="Magneto_RPM_LEFT"/>
                            <Operator OpType="And">
                                <Val SimVarName="RECIP ENG RIGHT MAGNETO:1" Units="Boolean"/>
                                <Operator OpType="Not">
                                    <Val SimVarName="RECIP ENG LEFT MAGNETO:1" Units="Boolean"/>
                                </Operator>
                            </Operator>
                        </Operator>
                    </TestValue>
                    <Duration Value="1.5" Cumulative="False"/>
                    <Instrument id="MAGNETO"/>
                    <Action Copilot="True" Condition="TestValueFalse" Once="true" EventID="MAGNETO_RIGHT"/>
                </Test>
                <Test>
                    <TestValue>

```

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

### Input Events (K Vars) Example

Source: https://docs.flightsimulator.com/html/Programming_Tools/JavaScript/Simvar.htm

Examples of initiating input events using 'K' Vars.

```APIDOC
## Input Events (K Vars)

### Description
Input events are initiated using 'K' vars, prefixed with 'K:'. Some events may require an additional value.

### Example
```javascript
SimVar.SetSimVarValue("K:FLAPS_INCR", "number", 0);
```

### Example with Value
```javascript
SimVar.SetSimVarValue("K:AXIS_ELEVATOR_SET", "number", -8225);
```
```

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

### Complete Model XML Example

Source: https://docs.flightsimulator.com/html/Content_Configuration/Models/Model_Examples.htm

This is a complete example of a model's XML configuration.

```xml
</Component>
    </Behaviors>
</ModelInfo>
```

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

### Spawn VFX on SimObject with Custom Parameters

Source: https://docs.flightsimulator.com/html/Programming_Tools/WASM/VFX_API/fsVfxSpawnOnSimObject.htm

This example demonstrates spawning a VFX on a SimObject with a specific offset and custom graph parameters. The VFX is attached to the root node, and its color is dynamically set based on the elevator deflection percentage. Ensure the VFX GUID is valid and loaded.

```c++
FsVec3d offset = { 0, 0, -5 };
FsVfxGraphParam graphParams[3];
graphParams[0].paramName = "ColorR";
graphParams[0].RPNExpression = "1";
graphParams[1].paramName = "ColorG";
graphParams[1].RPNExpression = "0";
graphParams[2].paramName = "ColorB";
graphParams[2].RPNExpression = "(A:ELEVATOR DEFLECTION PCT, Percent Over 100)";
g_SpawnVars.fxBackId = fsVfxSpawnOnSimObject("AAF9ECBE-C092-429A-877B-D41357D1E519", 0, nullptr, offset, { 0,0,0 }, -1, graphParams, 3);
```

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

### Example Camera and Target Names

Source: https://docs.flightsimulator.com/html/Samples_And_Tutorials/Tutorials/Creating_Hanger_Showcase_RTCs.htm

An example illustrating the camera and target naming convention.

```plaintext
Husky_MainPanelPanorama_CAMERA
Husky_MainPanelPanorama_TARGET
```

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

### SIMCONNECT_RECV_ENUMERATE_INPUT_EVENT_PARAMS Example 2

Source: https://docs.flightsimulator.com/html/Programming_Tools/SimConnect/API_Reference/InputEvents/SimConnect_EnumerateInputEventParams.htm

This example demonstrates the response structure when an instrument has multiple arguments, like a FLOAT64 and a STRING.

```plaintext
SIMCONNECT_RECV_ENUMERATE_INPUT_EVENT_PARAMS:
{
Hash = <Hash>;
Value = ";FLOAT64;char[256]"
}
```

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

### Configure Starter Control (Default)

Source: https://docs.flightsimulator.com/html/Content_Configuration/Models/ModelBehaviors/TemplateExplorer/Asobo/Common/Inputs/Electrical_Inputs.html

Sets up a starter control with default parameters, including increment/decrement events and initial state handling. This is used for basic starter interactions.

```XML
<Preset ID="ELECTRICAL_Starter_#STARTER_ID#">
 <Parameters Type="Default">
 <Switch Param="INTERACTION_TYPE">
 <Case Value="SWITCH">
 <Switch Param="NUM_STATES">
 <Case Value="3">
 <UPPER_LIMIT>2</UPPER_LIMIT>
 </Case>
 <Default>
 <UPPER_LIMIT>1</UPPER_LIMIT>
 </Default>
 </Switch>
 </Case>
 <Default>
 <UPPER_LIMIT>1</UPPER_LIMIT>
 </Default>
 </Switch>
 <STARTER_SET_KEY>(&gt;K:SET_STARTER#STARTER_ID#_HELD)</STARTER_SET_KEY>
 <INCREMENT>1</INCREMENT>
 <LOWER_LIMIT>0</LOWER_LIMIT>
 <ON_BEFORE_INC/>
 <ON_BEFORE_DEC/>
 <ON_BEFORE_SET/>
 <ON_AFTER_INC_EXTERNAL_CODE/>
 <ON_AFTER_DEC_EXTERNAL_CODE/>
 <ON_AFTER_SET/>
 <ON_AFTER_INC/>
 <ON_AFTER_DEC/>
 <Condition Check="SWITCH_POSITION_VAR">
 <True>
 <INPUTEVENT_VAR_TYPE>#SWITCH_POSITION_TYPE#</INPUTEVENT_VAR_TYPE>
 <INPUTEVENT_VAR_NAME>#SWITCH_POSITION_VAR#</INPUTEVENT_VAR_NAME>
 </True>
 <False>
 <INPUTEVENT_VAR_TYPE>L</INPUTEVENT_VAR_TYPE>
 <INPUTEVENT_VAR_NAME>ELECTRICAL_Starter_#STARTER_ID#</INPUTEVENT_VAR_NAME>
 </False>
 </Condition>
 </Parameters>
 <Parameters Type="Default">
 <ON_STATE_CHANGED_EXTERNAL_CODE/>
 <TT_DESCRIPTION_ID>@TT_Package.ELECTRICAL_PUSH_START_ACTION</TT_DESCRIPTION_ID>
 <Condition Check="COVER_VAR_NAME">
 <True>
 <COVER_CHECK>(#COVER_VAR_TYPE#:#COVER_VAR_NAME#) *</COVER_CHECK>
 </True>
 <False>
 <COVER_CHECK></COVER_CHECK>
 </False>
 </Condition>
 </Parameters>
 <Parameters Type="Override">
 <INC_EVENT>1 (&gt;B:ELECTRICAL_Starter_#STARTER_ID#_Set)</INC_EVENT>
 <DEC_EVENT>0 (&gt;B:ELECTRICAL_Starter_#STARTER_ID#_Set)</DEC_EVENT>
 <SET_EVENT> p0 #COVER_CHECK# #LOWER_LIMIT# max #UPPER_LIMIT# min s0 (O:ForceHeld) if{ (&gt;K:SET_STARTER#STARTER_ID#_HELD) } els{ (O:ForceNotHeld) if{ (&gt;K:STARTER#STARTER_ID#_SET) } els{ #STARTER_SET_KEY# } } l0 (&gt;#INPUTEVENT_VAR_TYPE#:#INPUTEVENT_VAR_NAME#) </SET_EVENT>
 <INIT_VALUE>(A:GENERAL ENG STARTER:#STARTER_ID#, Bool) (&gt;#INPUTEVENT_VAR_TYPE#:#INPUTEVENT_VAR_NAME#)</INIT_VALUE>
 <TOOLTIP_VALUE>(#INPUTEVENT_VAR_TYPE#:#INPUTEVENT_VAR_NAME#) @TT_OnOff_Cond</TOOLTIP_VALUE>
 <ON_STATE_CHANGED>0 (&gt;O:ForceHeld) 0 (&gt;O:ForceNotHeld)</ON_STATE_CHANGED>
 <Switch Param="INTERACTION_TYPE">
 <Case Value="SWITCH">
 <Switch Param="NUM_STATES">
 <Case Value="3">
 <INC_EVENT>(#INPUTEVENT_VAR_TYPE#:#INPUTEVENT_VAR_NAME#) p0 + (&gt;B:ELECTRICAL_Starter_#STARTER_ID#_Set)</INC_EVENT>
 <DEC_EVENT>(#INPUTEVENT_VAR_TYPE#:#INPUTEVENT_VAR_NAME#) p0 - (&gt;B:ELECTRICAL_Starter_#STARTER_ID#_Set)</DEC_EVENT>
 <INIT_VALUE> #STATE0_TEST# if{ 0 (&gt;#INPUTEVENT_VAR_TYPE#:#INPUTEVENT_VAR_NAME#) quit }
 #STATE1_TEST# if{ 1 (&gt;#INPUTEVENT_VAR_TYPE#:#INPUTEVENT_VAR_NAME#) quit }
 #STATE2_TEST# if{ 2 (&gt;#INPUTEVENT_VAR_TYPE#:#INPUTEVENT_VAR_NAME#) quit }
 </INIT_VALUE>
 <SET_EVENT> p0 #LOWER_LIMIT# max #UPPER_LIMIT# min s0 (&gt;#INPUTEVENT_VAR_TYPE#:#INPUTEVENT_VAR_NAME#)
 l0 0 == if{ #CODE_POS_0# quit }
 l0 1 == if{ #CODE_POS_1# quit }
 l0 2 == if{ #CODE_POS_2# quit }
 </SET_EVENT>
 <TOOLTIP_VALUE> (#INPUTEVENT_VAR_TYPE#:#INPUTEVENT_VAR_NAME#) s0 0 == if{ (R:1:@TT_Package.GT_STATE_START) quit }
 l0 1 == if{ (R:1:@TT_Package.GT_STATE_ON) quit }
 l0 2 == if{ @TT_Off quit }
 </TOOLTIP_V
```

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

### GUID Example in cameras.cfg

Source: https://docs.flightsimulator.com/html/Introduction/Using_The_SDK.htm

Example of a GUID used as a unique identifier for an asset, such as a camera definition in the cameras.cfg file.

```ini
Guid = "{195EAB58-9E4A-1E2A-A34C-A8D9D948F078}" ; Camera definition unique identifier. This GUID must be unique.

```

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

### Package Structure Example

Source: https://docs.flightsimulator.com/html/Introduction/Using_The_SDK.htm

Illustrates the directory structure of two packages, demonstrating how file paths are resolved in the Virtual File System (VFS) based on mounting order.

```plaintext
Packages
+-- package-01
|   |-- manifest.json
|   |-- layout.json
|   +-- MyDirectory
|       |-- myfile.cfg
+-- package-02
|   |-- manifest.json
|   |-- layout.json
|   +-- MyDirectory
|       |-- myfile.cfg
```

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

### Example SIMVAR_TO_WATCH

Source: https://docs.flightsimulator.com/html/Samples_And_Tutorials/Tutorials/Creating_Interactions_Using_InputEvents.htm

This example shows how to specify a SimVar to watch for changes. The '#' should be replaced with a number starting from 0.

```xml
<SIMVAR_TO_WATCH_0>LIGHT PANEL:2</SIMVAR_TO_WATCH_0>
```

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

### Get Time Since Flight Start

Source: https://docs.flightsimulator.com/html/Content_Configuration/SimObjects/Aircraft_SimO/Instruments/Panel_XML_Logic_Elements.htm

Retrieves the elapsed time in seconds since the flight was started.

```XML
<TimeSinceStart />
```

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

### Example LOCAL_VAR_TO_WATCH

Source: https://docs.flightsimulator.com/html/Samples_And_Tutorials/Tutorials/Creating_Interactions_Using_InputEvents.htm

This example demonstrates how to specify a local variable to watch for changes. The '#' should be replaced with a number starting from 0.

```xml
<LOCAL_VAR_TO_WATCH_0>XMLVAR_MyLocalVar</LOCAL_VAR_TO_WATCH_0>
```

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

### Define Engine Sound Transitions

Source: https://docs.flightsimulator.com/html/mergedProjects/How_To_Make_An_Aircraft/Contents/Audio/Advanced_Sound_xml.htm

Specifies an audio sample to play during a change in engine state (On, Off, Start). This example plays an engine combustion start sound when transitioning from the 'Start' state to the 'On' state.

```xml
<EngineSoundTransitions>
    <Sound WwiseEvent="eng1_combustion_start" WwiseData="true" ConeHeading="110" Continuous="false" ContinuousStopDelay="1" FadeOutType="2" FadeOutTime="4" EngineIndex="1" StateTo="On" StateFrom="Start" />
</EngineSoundTransitions>
```

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

### SimConnect.cfg Example Configurations

Source: https://docs.flightsimulator.com/html/Programming_Tools/SimConnect/SimConnect_CFG_Definition.htm

This example shows two distinct configurations for the SimConnect.cfg file, demonstrating different protocols and port settings. The index number in [SimConnect._N_] corresponds to the parameter in SimConnect_Open.

```cfg
[SimConnect.0]
Protocol=Pipe
Port=Custom/SimConnect
Address=127.0.0.1
 
[SimConnect.1]
Protocol=Ipv6
Port=501
Address=127.0.0.1
 
; Further connections here if required

```

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

### Example Wwise Event Naming

Source: https://docs.flightsimulator.com/html/Asset_Creation/Sounds/Using_Wwise.htm

Example of how to set up XML and the resulting Wwise event name for a specific sound.

```xml
<WindSounds>
    <Sound WwiseEvent="wind_sound" WwiseData="true" />
</WindSounds>
```

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

### Starter Template - Switch Interaction

Source: https://docs.flightsimulator.com/html/Content_Configuration/Models/ModelBehaviors/TemplateExplorer/Asobo/Common/Subtemplates/Electrical_Subtemplates.html

Configures a starter component for 'SWITCH' interaction type. It handles covered states, uses ASOBO_GT_Switch_Covered for covered interactions, and ASOBO_GT_Push_Button for uncovered interactions. Includes Wwise events for sound.

```XML
<Template Name="ASOBO_ELECTRICAL_Starter_Template">
 <Parameters Type="Default">
 <ANIM_NAME>ELECTRICAL_#INTERACTION_TYPE#_Starter_#ID#</ANIM_NAME>
 <NODE_ID>ELECTRICAL_#INTERACTION_TYPE#_Starter_#ID#</NODE_ID>
 <PART_ID>ELECTRICAL_#INTERACTION_TYPE#_Starter</PART_ID>
 <MOMENTARY_MIN_DURATION>1.5</MOMENTARY_MIN_DURATION>
 <Condition Valid="COVERED">
 <COVER_NODE_ID>ELECTRICAL_#INTERACTION_TYPE#_Starter_#ID#_Cover</COVER_NODE_ID>
 <COVER_ANIM_NAME>ELECTRICAL_#INTERACTION_TYPE#_Starter_#ID#_Cover</COVER_ANIM_NAME>
 </Condition>
 <STARTER_ID>#ID#</STARTER_ID>
 <TOOLTIP_STARTER_TITLE>@TT_Package.ELECTRICAL_PUSH_START_TITLE</TOOLTIP_STARTER_TITLE>
 </Parameters>
 <Parameters Type="Override">
 <TOOLTIP_TITLE>#TOOLTIP_STARTER_TITLE#</TOOLTIP_TITLE>
 <TOOLTIP_ENTRY_0>ELECTRICAL_Starter_#ID#</TOOLTIP_ENTRY_0>
 <Switch>
 <Case Valid="USE_ENFORCED_MOMENTARY_MIN_DURATION">
 <STOP_STARTER>(O:_Interacting) ! if{ 0 (&gt;K:SET_STARTER#ID#_HELD) }</STOP_STARTER>
 </Case>
 <Default>
 <STOP_STARTER>0 (&gt;K:SET_STARTER#ID#_HELD)</STOP_STARTER>
 </Default>
 </Switch>
 <Condition Valid="PREVENT_STARTER_RELEASE">
 <True>
 <RELEASE_STARTER_CODE/>
 </True>
 <False>
 <Switch Param="INTERACTION_TYPE">
 <Case Value="SWITCH">
 <RELEASE_STARTER_CODE>0 (&gt;B:ELECTRICAL_Starter_#ID#_Off)</RELEASE_STARTER_CODE>
 </Case>
 <Case Value="PUSH">
 <RELEASE_STARTER_CODE>0 (&gt;B:ELECTRICAL_Starter_#ID#_Set)</RELEASE_STARTER_CODE>
 </Case>
 </Switch>
 </False>
 </Condition>
 </Parameters>
 <Parameters Type="Default">
 <Condition Valid="COVERED">
 <LOCK_NODE_ID>#COVER_NODE_ID#</LOCK_NODE_ID>
 <LOCK_ANIM_NAME>#COVER_ANIM_NAME#</LOCK_ANIM_NAME>
 </Condition>
 </Parameters>
 <Switch Param="INTERACTION_TYPE">
 <Case Value="SWITCH">
 <Condition Valid="COVERED">
 <True>
 <UseTemplate Name="ASOBO_GT_Switch_Covered">
 <INPUT_EVENT_ID>ELECTRICAL</INPUT_EVENT_ID>
 <COVER_IE_NAME>Starter_#ID#_Cover</COVER_IE_NAME>
 <COVER_IE_ID_SOURCE>ELECTRICAL</COVER_IE_ID_SOURCE>
 <SWITCH_NODE_ID>#NODE_ID#</SWITCH_NODE_ID>
 <SWITCH_ANIM_NAME>#ANIM_NAME#</SWITCH_ANIM_NAME>
 <COVER_VAR_NAME>XMLVAR_ELECTRICAL_Starter_#ID#_Cover_Opened</COVER_VAR_NAME>
 <COVER_VAR_TYPE>I</COVER_VAR_TYPE>
 <SWITCH_TYPE>MOMENTARY</SWITCH_TYPE>
 <SET_SWITCH_ON>(&gt;B:ELECTRICAL_Starter_#ID#_On)</SET_SWITCH_ON>
 <SET_SWITCH_OFF>#RELEASE_STARTER_CODE#</SET_SWITCH_OFF>
 <SWITCH_ANIM_CODE>(B:ELECTRICAL_Starter_#ID#, Bool) 100 *</SWITCH_ANIM_CODE>
 <WWISE_EVENT_1>starter_switch_on</WWISE_EVENT_1>
 <WWISE_EVENT_2>starter_switch_off</WWISE_EVENT_2>
 </UseTemplate>
 </True>
 <False>
 <Component ID="#NODE_ID#" Node="#NODE_ID#">
 <UseInputEvent ID="ELECTRICAL"/>
 <UseTemplate Name="ASOBO_GT_Push_Button">
 <OVERRIDE_ANIM_CODE>(B:ELECTRICAL_Starter_#ID#, Bool) 100 *</OVERRIDE_ANIM_CODE>
 <LEFT_SINGLE_CODE>(&gt;B:ELECTRICAL_Starter_#ID#_On)</LEFT_SINGLE_CODE>
 <LEFT_LEAVE_CODE>#RELEASE_STARTER_CODE#</LEFT_LEAVE_CODE>
 <WWISE_EVENT_1>starter_switch_on</WWISE_EVENT_1>
 <WWISE_EVENT_2>starter_switch_off</WWISE_EVENT_2>
 </UseTemplate>
 </Component>
 </False>
 </Condition>
 </Case>
 <Case Value="PUSH">
 <Component ID="#NODE_ID#" Node="#NODE_ID#">
 <UseTemplate Name="ASOBO_GT_Update">
 <FREQUENCY>5</FREQUENCY>
 <UPDATE_CODE> (O:XMLVAR_Starter_Held_Down_Duration) 0 &gt; if{ (O:XMLVAR_Starter_Held_Down_Duration) (E:SIMULATION TIME, seconds) &lt; if{ 0 (&gt;O:XMLVAR_Starter_Held_Down_Duration) #STOP_STARTER# }
 }
 </UPDATE_CODE>
 </UseTemplate>
 <UseInputEvent ID="ELECTRICAL"/>
 <UseTemplate Name="ASOBO_GT_Push_Button_Held">
 <OVERRIDE_ANIM_CODE>(B:ELECTRICAL_Starter_#ID#) 100 *</OVERRIDE_ANIM_CODE>
 <SWITCH_POSITION_TYPE>L</SWITCH_POSITION_TYPE>
 <SWITCH_POSITION_VAR>XMLVAR_Starter_State</SWITCH_POSITION_VAR>
 <Switch>
 <Case Valid="USE_ENFORCED_MOMENTARY_MIN_DURATION">
 <LEFT_SINGLE_CODE>1 (&gt;O:_Interacting) 1 (&gt;B:ELECTRICAL_Starter_#ID#_Set) #MOMENTARY_MIN_DURATION# (E:SIMULATION TIME, seconds) + (&gt;O:XMLVAR_Starter_Held_Down_Duration)</LEFT_SINGLE_CODE>
 <LEFT_LEAVE_CODE>0 (&gt;O:_Interacting) (O:XMLVAR_Starter_Held_Down_Duration) 0 == if{ #RELEASE_STARTER_CODE# }</LEFT_LEAVE_CODE>
 <WHEEL_DOWN_CODE>1 (&gt;B:ELECTRICAL_Starter_#ID#_Set) #MOMENTARY_MIN_DURATION# (E:SIMULATION TIME, seconds) + (&gt;O:XMLVAR_Starter_Held_Down_Duration)</WHEEL_DOWN_CODE>
 </Case>
 <Default>
 <LEFT_SINGLE_CODE>1 (&gt;B:ELECTRICAL_Starter_#ID#_Set)</LEFT_SINGLE_CODE>
 <LEFT_LEAVE_CODE>#RELEASE_STARTE
```

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

### Basic Fuel System Trigger Example

Source: https://docs.flightsimulator.com/html/Content_Configuration/SimObjects/Aircraft_SimO/flight_model/fuel_system.htm

A basic example of a single trigger definition that activates effects when Autostart is enabled. The effects include opening valves and starting pumps.

```plaintext
Trigger.1 = Condition:Autostart_Enabled
#EffectTrue:OpenValve.LeftEngValve,
OpenValve.RightEngValve,
OpenValve.CrossFeedValve,
StartPump.LeftTankPump,
StartPump.RightTankPump

```

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

### VisualEffect.Abs Node Configuration

Source: https://docs.flightsimulator.com/html/Content_Configuration/VisualEffects/Visual_Effects_Definitions.htm

Configures the Abs node to get the absolute value of an input. Requires an InstanceId GUID.

```xml
<VisualEffect.Abs InstanceId="{00000000-0000-0000-0000-000000000000}" />
```

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

### Services.xml Configuration Example

Source: https://docs.flightsimulator.com/html/Content_Configuration/Environment/Living_World/Airport_Services/Airport_Services_Examples.htm

This is a complete, valid Services.xml file demonstrating the structure for defining parking spaces, their associated services, and idle workers. It includes examples of parking types, service definitions, and sleeping activities.

```xml
<?xml version="1.0" encoding="UTF-8"?>
<SimBase.Document Type="ServiceFile" version="1,0">
    <Service.ParkingSpaceServices>
        <!-- You can choose a custom name for your parking space -->
        <ParkingSpace name="RAMP MEDIUM" MinParkingSpaces="2">
            <ParkingTypes>
                <!-- This means that it will affect both RAMP_GA and RAMP_GA_MEDIUM Parking type -->
                <ParkingEntry ParkingType="RAMP_GA_MEDIUM"/>
                <ParkingEntry ParkingType="RAMP_GA"/>
            </ParkingTypes>
            <IdleWorkers>
                <Spot Frequency="1" SpawnDistanceParkingRadiusFactor="1.0" SpawnDistanceAdditionalOffset="2.0" SpawnAngleFromParking="-100" HeadingFromParkingHeading="90" >
                   <IdleWorker Filename="Shared\Asobo_IdleWorkers\Large\V1" EntryWeight="1"/>
                </Spot>
                <Spot Frequency="1" SpawnDistanceParkingRadiusFactor="1.0" SpawnDistanceAdditionalOffset="12.0" SpawnAngleFromParking="110" HeadingFromParkingHeading="-80" >
                    <IdleWorker Filename="Shared\Asobo_IdleWorkers\Large\V1" EntryWeight="1"/>
                    <IdleWorker Filename="Shared\Asobo_IdleWorkers\Large\V2" EntryWeight="1"/>
                </Spot>
            </IdleWorkers>
            <Services>
                <!-- Delete or comment a <Service../> you do not want for a selected parking space -->
                <Service name="GroundPowerUnit" Filename="Shared\Asobo_GroundPowerUnit\GroundPowerUnit" AIType="GROUNDPOWERUNIT" Frequency="0.25" SpawnDistanceParkingRadiusFactor="1.0" SpawnDistanceAdditionalOffset="4.0" SpawnAngleFromParking="20" HeadingFromParkingHeading="50"/>
                <Service name="SmallPushBack" Filename="Shared\Asobo_PushBack\SmallPushBack" AIType="SmallPushback" Frequency="1" SpawnDistanceParkingRadiusFactor="1.0" SpawnDistanceAdditionalOffset="2.0" SpawnAngleFromParking="-10" HeadingFromParkingHeading="150"/>
            </Services>  
            <SleepingActivities>
                <SleepingAirlinerServices Probability="0.1" Timer="600"/>
                <SleepingSmallPlaneRefueling Probability="0.1" Timer="600"/>
            </SleepingActivities>
        </ParkingSpace>
    </Service.ParkingSpaceServices>
    <Service.AirportServices>
        <Services>
            <Service name="Fuel" Filename="Shared\Asobo_Fuel\Fuel" ParkingType="VEHICLE" Frequency="1"/>
        </Services>
    </Service.AirportServices>
</SimBase.Document>
```

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

### Loading Screen Tip Example

Source: https://docs.flightsimulator.com/html/Developer_Mode/Aircraft_Editor/Tabs/The_Aircraft_Tab.htm

Example of a localized tip text format for the aircraft loading screen. Ensure the format matches the expected structure for package name, text, and optional category.

```plaintext
TT:LOADING.TIPS.AIRCRAFTNAME_000
```

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

### Self-Closing XML Tag Example

Source: https://docs.flightsimulator.com/html/Additional_Information/File_Formats/XML_Files.htm

A self-closing tag combines the start and end tags into a single tag, often used for elements that do not contain content.

```xml
<LibraryObject name="{830B4ADB-A72F-45F6-82C2-BF1F64FF81EE}" scale="1.425599"/>
```

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

### Basic Behavior XML Structure

Source: https://docs.flightsimulator.com/html/mergedProjects/How_To_Make_An_Aircraft/Contents/Model_Behaviours/Model_Behaviours.htm

This is an example of the overall basic structure for defining behaviors within a model's XML file, showcasing a hierarchical component setup.

```xml
<Behaviors>
    <Component ID="Left_Panel">
        <Component ID="Throttle_Section">
        </Component>
        <Component ID="Lights_Section">
            <Component ID="Exterior_Lights">
            </Component>
            <Component ID="Interior_Lights">
            </Component>
        </Component>
    </Component>
    <Component ID="Right_Panel">
        <Component ID="Fuel_Section">
        </Component>
        <Component ID="Trim_Section">
        </Component>
    </Component>
    <Component ID="Front_Panel">
        <Component ID="Instruments_Section">
        </Component>
        <Component ID="Glasscockpits_Section">
        </Component>
    </Component>
    <Component ID="Overhead_Panel">
         <Component ID="Engine_Start_Section">
         </Component>
    </Component>
</Behaviors>
```

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

### GDI+ Bitmap Initialization with Graphics Context

Source: https://docs.flightsimulator.com/html/Programming_Tools/WASM/GDI%2B.htm

When creating a GDI+ Bitmap, it requires an active GdiPlus::Graphics object. This example shows how to initialize a Bitmap using a provided fsctx.

```cpp
GdiPlus::Graphics* gfx = new Graphics(fsctx);
      ...
bitmap = new Bitmap(gfx,L"{path-to-file-in-vfs.png}"

```

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

### Get Maximum Simvar Value Since Start

Source: https://docs.flightsimulator.com/html/Content_Configuration/SimObjects/Aircraft_SimO/Instruments/Panel_XML_Logic_Elements.htm

Retrieves the maximum value a Simvar has reached since the flight began. A `<ResetCondition>` sub-element can be used to reset this maximum value.

```XML
<MaxSinceStart>
    <Simvar name="AIRSPEED INDICATED" unit="knots"/>
</MaxSinceStart>
```

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

### List Parameters in CFG Files

Source: https://docs.flightsimulator.com/html/Additional_Information/File_Formats/CFG_Files.htm

Demonstrates how to define lists of parameters by appending numbers to parameter names.

```cfg
[fltsim]
fallback.1 = scenery\texture
fallback.2 = Asobo_AirRace\texture

```

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

### Get Minimum Simvar Value Since Start

Source: https://docs.flightsimulator.com/html/Content_Configuration/SimObjects/Aircraft_SimO/Instruments/Panel_XML_Logic_Elements.htm

Retrieves the minimum value a Simvar has reached since the flight began. A `<ResetCondition>` sub-element can be used to reset this minimum value.

```XML
<MinSinceStart>
    <Simvar name="BAROMETER PRESSURE" unit="Millibars"/>
</MinSinceStart>
```

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

### Configure Loading Screen Images and Tips

Source: https://docs.flightsimulator.com/html/Content_Configuration/Flights_And_Missions/Flight_Definitions.htm

Set loading screen images and associated tips. `ImageName._N_` specifies the image path, and `Tips_N_` provides text displayed with the image. Multiple tips can be defined for each image.

```plaintext
ImageName.0=./Loading/Images/MyMissionImage.png
Tips0=TT:LOADING.TIPS.MISSIONNAME_000
Tips1=TT:LOADING.TIPS.MISSIONNAME_001
Tips2=TT:LOADING.TIPS.MISSIONNAME_002
```

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

### Get SimVar Value for Compass

Source: https://docs.flightsimulator.com/html/Programming_Tools/JavaScript/Simvar.htm

Example demonstrating how to retrieve different compass-related SimVar values based on the map rotation mode. Note that 'Simplane.getHeadingTrue()' is used as an alternative when not directly fetching a SimVar.

```javascript
switch (this.mapRotationMode) {
    case EMapRotationMode.DTKUp:
        compass = SimVar.GetSimVarValue("GPS WP DESIRED TRACK", "degrees");
        break;
    case EMapRotationMode.HDGUp:
        compass = Simplane.getHeadingTrue();
        break;
    case EMapRotationMode.TrackUp:
        compass = SimVar.GetSimVarValue("GPS GROUND TRUE TRACK", "degrees");
        break;
    default:
        compass = 0;
        break;
}
```

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

### PackageInstaller File Structure

Source: https://docs.flightsimulator.com/html/Samples_And_Tutorials/Samples/VisualStudio/PackageInstaller.htm

This outlines the directory and file structure of the PackageInstaller sample project. It includes the main solution file, custom action source files, WiX project files, and the packages to be installed.

```plaintext
|---+ PackageInstaller
    |---+ DetectMSFS
    |   |---- CustomAction.cpp
    |   |---- CustomAction.def
    |   |---- DetectMSFS.vcxproj
    |   |---- stdafx.cpp
    |   |---- stdafx.h
    |   |---- targetver.h
    |---+ PackageInstaller
    |   |---- CustomAction.wxs
    |   |---- PackageFiles.wxs
    |   |---- PackageInstaller.wixproj
    |   |---- Product.wxs
    |---+ Packages
    |   |---+ mycompany-module-standalone
    |       |---+ modules
    |       |   |---- StandaloneModule.wasm
    |       |---- layout.json
    |       |---- manifest.json
    |---- PackageInstaller.sln
```

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

### Request Facilities List - C++ Example

Source: https://docs.flightsimulator.com/html/Programming_Tools/SimConnect/API_Reference/Facilities/SimConnect_RequestFacilitesList.htm

This C++ example demonstrates how to request a list of facilities of a specific type using SimConnect_RequestFacilitesList. It shows the function signature and parameters required for the call.

```cpp
HRESULT SimConnect_RequestFacilitesList(
    HANDLE  hSimConnect,
    SIMCONNECT_FACILITY_LIST_TYPE  type,
    SIMCONNECT_DATA_REQUEST_ID  RequestID
    );
```

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

### Get Last Sent Packet ID

Source: https://docs.flightsimulator.com/html/Programming_Tools/SimConnect/API_Reference/Debug/SimConnect_GetLastSentPacketID.htm

This example demonstrates how to map a client event, transmit it, and then retrieve the ID of the last sent packet. This function is primarily intended for debugging and testing client applications.

```C++
DWORD dwLastID;
hr = SimConnect_MapClientEventToSimEvent(hSimConnect, EVENT_MY_EVENT, "Custom.Event");
hr = SimConnect_TransmitClientEvent(hSimConnect, 0, EVENT_MY_EVENT, 0, SIMCONNECT_GROUP_PRIORITY_HIGHEST, 0);
hr = SimConnect_GetLastSentPacketID(hSimConnect, &dwLastID);
```

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

### APU Starter Configuration (3 States)

Source: https://docs.flightsimulator.com/html/Content_Configuration/Models/ModelBehaviors/TemplateExplorer/Asobo/Common/Inputs/Electrical_Inputs.html

Configures the APU starter with 3 states, defining interaction types, limits, and events for increment, decrement, and set actions. Includes specific logic for each state transition and tooltip values.

```XML
<Preset ID="ELECTRICAL_APU_Starter"> <Parameters Type="Default"> <INCREMENT>1</INCREMENT> <LOWER_LIMIT>0</LOWER_LIMIT> <Switch Param="INTERACTION_TYPE"> <Case Value="SWITCH"> <Switch Param="NUM_STATES"> <Case Value="3"> <UPPER_LIMIT>2</UPPER_LIMIT> </Case> <Default> <UPPER_LIMIT>1</UPPER_LIMIT> </Default> </Switch> </Case> <Default> <UPPER_LIMIT>1</UPPER_LIMIT> </Default> </Switch> <ON_BEFORE_INC/> <ON_BEFORE_DEC/> <ON_BEFORE_SET/> <ON_AFTER_INC_EXTERNAL_CODE/> <ON_AFTER_DEC_EXTERNAL_CODE/> <ON_AFTER_SET/> <ON_AFTER_INC/> <ON_AFTER_DEC/> <ON_STATE_CHANGED/> <Condition Check="SWITCH_POSITION_VAR"> <True> <INPUTEVENT_VAR_TYPE>#SWITCH_POSITION_TYPE#</INPUTEVENT_VAR_TYPE> <INPUTEVENT_VAR_NAME>#SWITCH_POSITION_VAR#</INPUTEVENT_VAR_NAME> </True> <False> <INPUTEVENT_VAR_TYPE>L</INPUTEVENT_VAR_TYPE> <INPUTEVENT_VAR_NAME>ELECTRICAL_APU_Starter</INPUTEVENT_VAR_NAME> </False> </Condition> </Parameters> <Parameters Type="Default"> <ON_STATE_CHANGED_EXTERNAL_CODE/> </Parameters> <Parameters Type="Override"> <TOOLTIP_VALUE>(#INPUTEVENT_VAR_TYPE#:#INPUTEVENT_VAR_NAME#) @TT_OnOff_Cond</TOOLTIP_VALUE> <INC_EVENT>1 (&gt;B:ELECTRICAL_APU_Starter_Set)</INC_EVENT> <DEC_EVENT>0 (&gt;B:ELECTRICAL_APU_Starter_Set)</DEC_EVENT> <SET_EVENT> p0 #LOWER_LIMIT# max #UPPER_LIMIT# min s0 if{ (&gt;K:APU_STARTER) } els{ (&gt;K:APU_OFF_SWITCH) } l0 (&gt;#INPUTEVENT_VAR_TYPE#:#INPUTEVENT_VAR_NAME#) </SET_EVENT> <INIT_VALUE>(A:APU SWITCH, Bool) (&gt;#INPUTEVENT_VAR_TYPE#:#INPUTEVENT_VAR_NAME#)</INIT_VALUE> <TOOLTIP_DESCRIPTION>@TT_Package.ELECTRICAL_SWITCH_APU_STARTER_ACTION_SET</TOOLTIP_DESCRIPTION> <Switch Param="INTERACTION_TYPE"> <Case Value="SWITCH"> <Switch Param="NUM_STATES"> <Case Value="3"> <INC_EVENT>(#INPUTEVENT_VAR_TYPE#:#INPUTEVENT_VAR_NAME#) p0 + (&gt;B:ELECTRICAL_APU_Starter_Set)</INC_EVENT> <DEC_EVENT>(#INPUTEVENT_VAR_TYPE#:#INPUTEVENT_VAR_NAME#) p0 - (&gt;B:ELECTRICAL_APU_Starter_Set)</DEC_EVENT> <INIT_VALUE> #STATE0_TEST# if{ 0 (&gt;#INPUTEVENT_VAR_TYPE#:#INPUTEVENT_VAR_NAME#) quit } #STATE1_TEST# if{ 1 (&gt;#INPUTEVENT_VAR_TYPE#:#INPUTEVENT_VAR_NAME#) quit } #STATE2_TEST# if{ 2 (&gt;#INPUTEVENT_VAR_TYPE#:#INPUTEVENT_VAR_NAME#) quit } </INIT_VALUE> <SET_EVENT> p0 #LOWER_LIMIT# max #UPPER_LIMIT# min s0 (&gt;#INPUTEVENT_VAR_TYPE#:#INPUTEVENT_VAR_NAME#) l0 0 == if{ #CODE_POS_0# quit } l0 1 == if{ #CODE_POS_1# quit } l0 2 == if{ #CODE_POS_2# quit } </SET_EVENT> <TOOLTIP_VALUE> (#INPUTEVENT_VAR_TYPE#:#INPUTEVENT_VAR_NAME#) s0 0 == if{ @TT_Off quit } l0 1 == if{ @TT_On quit } l0 2 == if{ @TT_Start quit } </TOOLTIP_VALUE> </Case> </Switch> </Case> </Switch> </Parameters> <Parameters Type="Override"> <ON_STATE_CHANGED>#ON_STATE_CHANGED# #ON_STATE_CHANGED_EXTERNAL_CODE#</ON_STATE_CHANGED> <ON_AFTER_INC>#ON_AFTER_INC# #ON_AFTER_INC_EXTERNAL_CODE#</ON_AFTER_INC> <ON_AFTER_DEC>#ON_AFTER_DEC# #ON_AFTER_DEC_EXTERNAL_CODE#</ON_AFTER_DEC> </Parameters> <Parameters Type="Default"> <Switch Param="INTERACTION_TYPE"> <Case Value="SWITCH"> <Condition> <Test> <Greater> <Value>NUM_STATES</Value> <Number>2</Number> </Greater> </Test> <True> <Condition Check="SWITCH_DIRECTION" Match="Horizontal"> <True> <INTERACTION_FLAGS>PRIMARY_DOWN+X_AXIS</INTERACTION_FLAGS> <INTERACTION_LOCKABLE_FLAGS>X_AXIS</INTERACTION_LOCKABLE_FLAGS> <TT_ICON>MOVE_X</TT_ICON> </True> <False> <INTERACTION_FLAGS>PRIMARY_DOWN+Y_AXIS</INTERACTION_FLAGS> <INTERACTION_LOCKABLE_FLAGS>Y_AXIS</INTERACTION_LOCKABLE_FLAGS> <TT_ICON>MOVE_Y</TT_ICON> </False> </Condition> </True> <False> <INTERACTION_FLAGS>PRIMARY_DOWN</INTERACTION_FLAGS> <INTERACTION_LOCKABLE_FLAGS>LOCK</INTERACTION_LOCKABLE_FLAGS> <TT_ICON>PUSH</TT_ICON> </False> </Condition> </Case> <Default> <INTERACTION_FLAGS>PRIMARY_DOWN</INTERACTION_FLAGS> <INTERACTION_LOCKABLE_FLAGS>LOCK</INTERACTION_LOCKABLE_FLAGS> <TT_ICON>PUSH</TT_ICON> </Default> </Switch> </Parameters> <Tooltip> <Icon>#TT_ICON#</Icon> <Interaction>#INTERACTION_FLAGS#</Interaction> <InteractionLockable>#INTERACTION_LOCKABLE_FLAGS#</InteractionLockable> <TTDescription>#TOOLTIP_DESCRIPTION#</TTDescription> <TTVa
```

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

### Polygon Object Definition with Shared GUID and Attributes

Source: https://docs.flightsimulator.com/html/Content_Configuration/Environment/Scenery_Objects/Scenery_Object_Example.htm

Another polygon definition that shares the same 'UniqueGUID' and vegetation attributes as the previous example, indicating a potential grouping or shared characteristic. Note the different vertex coordinates.

```xml
<Polygon parentGroupID="9" groupIndex="6" altitude="264.15548706054688">
    <Attribute name="UniqueGUID" guid="{359C73E8-06BE-4FB2-ABCB-EC942F7761D0}" type="GUID" value="{A6AE81D5-13E1-4287-8499-58A72E741801}"/>
    <Attribute name="VegetationScale" guid="{6A043F59-E6F2-4117-A2E4-D510E7317C29}" type="UINT32" value="127"/>
    <Attribute name="VegetationDensity" guid="{41EFF715-C392-4B31-A457-50A504353A90}" type="UINT32" value="16"/>
    <Vertex lat="42.54923153029092" lon="-92.39673089493455"/>
    <Vertex lat="42.54903638929295" lon="-92.39658707821732"/>
    <Vertex lat="42.54908368617929" lon="-92.39648111659736"/>
    <Vertex lat="42.54929445171563" lon="-92.39655770625825"/>
</Polygon>
```

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

### Configure Engine Sound States

Source: https://docs.flightsimulator.com/html/mergedProjects/How_To_Make_An_Aircraft/Contents/Audio/Advanced_Sound_xml.htm

Sets an audio event to play when a specific engine state (Off, Start, On) is reached. This example plays a propeller sound when the engine is shutdown, using StateOff, StateStart, and StateOn booleans.

```xml
<EngineSoundStates>
    <Sound WwiseEvent="eng1_prop_non_combustion" WwiseData="true" EngineIndex="1" StateOff="true" StateStart="false" StateOn="false" FadeOutType="2" FadeOutTime="1" >
        <WwiseRTPC SimVar="PROP RPM" Units="RPM" Index="1" RTPCName="SIMVAR_PROP_RPM" />
        <WwiseRTPC SimVar="PROP MAX RPM PERCENT" Units="PERCENT OVER 100" Index="1" RTPCName="SIMVAR_PROP_MAX_RPM_PERCENT" />    
    </Sound>
</EngineSoundStates>
```
Tokens:
Raw