### Example of Wwise Event Naming Convention in XML Source: https://docs.flightsimulator.com/html/Asset_Creation/Sounds/Using_Wwise Illustrates how to set up an XML structure for a sound event in Wwise, which then translates into a specific event name following the defined convention. This example shows the setup for a wind sound. ```xml Resulting event name in Wwise: Play_MyAircraft_wind_sound ``` ```xml // For an AI aircraft sound: // Resulting event name in Wwise: Play_MyAircraft_ai_wind_sound ``` -------------------------------- ### Configure Engine Sound Transitions (XML) Source: https://docs.flightsimulator.com/html/Content_Configuration/Sounds/Sound_Examples This example demonstrates how to set a transition sound for an engine using the `` element. It specifies the sound to play when an engine transitions between states, such as from 'Start' to 'On', and targets a specific engine index. ```XML ``` -------------------------------- ### Configure Engine Sound States (XML) Source: https://docs.flightsimulator.com/html/Content_Configuration/Sounds/Sound_Examples Example of linking sounds to specific engine states (Start, On) using the `` element. This configuration ensures sounds play only when the engine is in the defined states, with `StateOff`, `StateStart`, and `StateOn` attributes controlling playback. ```XML ``` -------------------------------- ### Configure Acoustic Parameters (Reverberation) (XML) Source: https://docs.flightsimulator.com/html/Content_Configuration/Sounds/Sound_Examples Sets up acoustic parameters, specifically reverberation presets for inside and outside environments. This allows for distinct acoustic characteristics based on the listener's location relative to the sound source. Requires Wwise setup. ```xml ``` -------------------------------- ### Programming SimConnect Clients using Managed Code Source: https://docs.flightsimulator.com/html/Programming_Tools/SimConnect/API_Reference/Structures_And_Enumerations/SIMCONNECT_RECV_ENUMERATE_INPUT_EVENTS Guides and examples for developing SimConnect clients using managed code languages like C# and VB.NET. ```APIDOC ## Programming SimConnect Clients using Managed Code ### Description This section provides resources and examples for developers who want to create SimConnect clients using managed code environments such as .NET (C#, VB.NET). It covers setting up the development environment and interacting with SimConnect functionalities. ### Method N/A (Documentation guide) ### Endpoint N/A ### Parameters N/A ### Request Example N/A ### Response N/A ``` -------------------------------- ### Configure Miscellaneous Sounds (XML) Source: https://docs.flightsimulator.com/html/Content_Configuration/Sounds/Sound_Examples A simple example showing the use of the `` element to trigger various sounds, such as stall warnings, overspeed alerts, and pre-flight check confirmations. Each sound is defined by its Wwise event. ```XML ``` -------------------------------- ### Flight Simulator Example Source: https://docs.flightsimulator.com/html/Content_Configuration/Models/Model_Examples This example demonstrates a structure that iterates from a starting value to an ending value, incrementing by a specified amount each time. It sets up and modifies parameters within each iteration. ```XML AP_ID 1 1 #AP_COUNT# #RESET_CODE_T# #AP_ID# #ID# != if{ 0 (>L:XMLVAR_Autopilot_#AP_ID#_Status) } #RESET_CODE_T# ``` -------------------------------- ### Example Contact Point Configuration Source: https://docs.flightsimulator.com/html/Samples_And_Tutorials/Tutorials/Defining_A_Flight_Model An example of a configured contact point using the specified format in `flight_model.cfg`. This line sets a specific wheel's properties, including its class, position, crash velocity, and wheel radius, among other parameters. ```plaintext point.0 = 1, 1.1, 0, -3.44, 750, 0, 0.5, 10, 0.3185, 2, 0.75, 0, 0, 0, 0, 0 ``` -------------------------------- ### RTCCameraShot Example with Multiple Cameras (XML) Source: https://docs.flightsimulator.com/html/Content_Configuration/Cameras/RTC/RTC_Definition_Examples Demonstrates the configuration of an RTCCameraShot element with multiple RTCShotPoints. Each point defines a camera's GUID, name, and specific shot parameters like depth of field, duration, and interpolation. This allows for complex camera sequences within a simulation. ```xml CameraShot1 {8A1987D0-09B6-7E48-B4E1-62C5DBE2A720} FixedOnPlane_Belly True 0.2 {7a91803e-898b-435a-8391-725be6a48203} FixedOnPlane_LeftWing 10 PushMid {7a91803e-898b-435a-8391-725be6a48203} FixedOnPlane_LeftWing 3 PushEdge ``` -------------------------------- ### Define Visual Effect Objects in XML Source: https://docs.flightsimulator.com/html/Content_Configuration/Environment/Scenery_Objects/Scenery_Object_Example XML elements for placing visual effect objects in the simulator environment. Demonstrates referencing effect files by name, path/name, and GUID, along with placement and scaling parameters. ```xml ``` -------------------------------- ### Calculating Max Emergency Boost Time (engines.cfg Example) Source: https://docs.flightsimulator.com/html/Content_Configuration/SimObjects/Aircraft_SimO/Additional_CFG_Information Provides an example calculation for setting the 'max_emergency_boost_time' parameter in engines.cfg, considering manifold pressure limits and desired duration at maximum boost. ```text max_emergency_boost_time = 315 * (67/61) = 315 * 1.098 = 346 ``` -------------------------------- ### Example Fuel System Trigger Definition Source: https://docs.flightsimulator.com/html/Content_Configuration/SimObjects/Aircraft_SimO/flight_model/fuel_system This example demonstrates a basic configuration for a single fuel system trigger. It specifies a condition ('Autostart_Enabled') and lists the effects to be triggered when the condition is true, such as opening valves and starting pumps. ```plaintext Trigger.1 = Condition:Autostart_Enabled #EffectTrue:OpenValve.LeftEngValve, OpenValve.RightEngValve, OpenValve.CrossFeedValve, StartPump.LeftTankPump, StartPump.RightTankPump ``` -------------------------------- ### Configure SimVar Sounds with Ranges and Requirements (XML) Source: https://docs.flightsimulator.com/html/Content_Configuration/Sounds/Sound_Examples This advanced example demonstrates configuring sounds within `` that depend on multiple conditions. It includes playing sounds based on SimVar value ranges and additional requirements defined by `` elements, which can specify other SimVars or LocalVars with their own conditions. ```XML ``` -------------------------------- ### Define Checkpoint Library XML Source: https://docs.flightsimulator.com/html/Content_Configuration/Checklists/Checklist_Examples This XML structure defines a checkpoint library for Flight Simulator. It includes two example checkpoints: 'Parking_Brake_Set' and 'Brakes_Released', each with associated clues, descriptions, test conditions, and actions. ```xml ``` -------------------------------- ### Interaction Type Example Source: https://docs.flightsimulator.com/html/Samples_And_Tutorials/Tutorials/Creating_Interactions_Using_InputEvents Shows an example of setting the interaction type for an input event. The INTERACTION_TYPE parameter automatically configures templates, sound events, animations, and tooltips based on the selected type. ```xml Switch ``` -------------------------------- ### Looping Template Usage for Repetitive Elements (XML) Source: https://docs.flightsimulator.com/html/mergedProjects/How_To_Make_An_Aircraft/Contents/Model_Behaviours/Templates Shows how to use the `` element to simplify repetitive `` calls. The `` section defines values for a variable (e.g., MAP_MODE) and parameters, while the `` section contains the template usage that will be repeated for each setup value, creating multiple similar components efficiently. ```xml MAP_MODE <1>WXR <2>STA <3>WPT <4>ARPT <5>DATA <6>POS <7>TERR A_GLTF_NODE_PUSH_#MAP_MODE# (>H:Plane_MFD_MAP_#MAP_MODE#) ``` -------------------------------- ### RTCSequencer Calling an RTCShot (XML) Source: https://docs.flightsimulator.com/html/Content_Configuration/Cameras/RTC/RTC_Definition_Examples Shows how an RTCSequencer can invoke an RTCShot. This setup defines a sequence of actions, including a reference to a specific RTCShot that dictates camera position, orientation, and animation details for a particular scene. ```XML LandingChallengeIntroAirportID67 True RunwayShowCaseSequenceID67 N44° 48' 36.212",W114° 48' 32.579",+004200 0.000,0.000,174.000 {694C8754-5989-44D1-9DEA-BD706C719BA2} Move Camera Target ``` -------------------------------- ### Legacy FSX SimObject Animation XML Setup Source: https://docs.flightsimulator.com/html/Content_Configuration/Models/Model_Examples Demonstrates the setup for legacy FSX SimObjects animations, requiring a PartInfo block alongside the Animation definition. It links an animation to a simulator variable. ```xml c_gear 200 GEAR ANIMATION POSITION:0 keyframe ``` -------------------------------- ### While Loop Example Source: https://docs.flightsimulator.com/html/Content_Configuration/Models/ModelBehaviors/Program_Template_Definitions Demonstrates the structure of a 'while' loop in Flight Simulator XML. It sets up a parameter 'ID' starting from 1, increments it by 1 each iteration, and continues as long as the parameter 'MY_PARAM_#ID#' is valid. This loop has a default limit of 64 iterations unless a element is also specified. ```xml ID 1 1 ``` -------------------------------- ### Configure Engine Sound Presets (XML) Source: https://docs.flightsimulator.com/html/Content_Configuration/Sounds/Sound_Examples Examples of configuring sound presets for aircraft engines using the `` element. This includes setting up sounds for combustion, shutdown, and custom suffixes, along with specific configurations for helicopter rotors. It uses Wwise events and specifies engine or rotor indices and RPM thresholds. ```XML --> ``` ```XML ``` -------------------------------- ### Complete FLT Example for Flight Simulator Source: https://docs.flightsimulator.com/html/Content_Configuration/Flights_And_Missions/Flight_Weather_Event_Examples This code snippet represents a complete FLT file used in a flight simulator. It defines various parameters for a free flight mission, including mission type, location, aircraft configuration, weather settings, and system states. This file acts as a configuration script to load a specific flight scenario. ```ini [Main] MissionType=FreeFlight MissionLocation=London Title=London XO Description=London AppVersion=10.0.282174 FlightVersion=1 [Briefing] BriefingText=$$:London Freeflight BriefingImage0=./images/Briefing0.png [Options] Sound=True Pause=True Moonlight=True Save=False SaveOriginalFlightPlan=False TextDisplayPage=0 SlewDisplayPage=1 AxisIndicator=Off Titles=False [Sim.0] Sim=Cessna Skyhawk G1000 Asobo [ResourcePath] Path=Missions\Asobo\FreeFlights\FreeFlight\FreeFlight [ObjectFile] File=Missions\Asobo\FreeFlights\FreeFlight\FreeFlight [Atc_Menu] Visible=False [FreeFlight] FirstFlightState=PREFLIGHT_HOLDSHORT [TrafficManager] disable=False [Multiplayer] Status=False [AirTraffic] Status=False [Weather] UseWeatherFile=True WeatherCanBeLive=True WeatherType=0 DynamicWeatherOverride=1 CloudmapPosOverride=True CloudmapInitialPosX=4692.740 CloudmapInitialPosY=-10913.52 [Departure] ICAO=EGLC RunwayNumber=27 RunwayDesignator=NONE GateName=PARKING GateNumber=1 [Loading] ImageName=./images/Loading0.png Tips0=TT:LOADING.TIPS.C172_004 [Panels] Panel.On=True HUD.On=False [Window.1] Order=255 Active=True Undocked=False Maximized=True ScreenUniCoords=0, 0, 0, 0 UndocCoords=0, 0, 0, 0 [ATC_AgentManager] NumberofAgents=0 [ATC_Aircraft.0] ActiveFlightPlan=False RequestedFlightPlan=False AcState=ACSTATE_REQUEST_TAXI_CLEARANCE_OUT_VFR_ATIS NumberofWaypoints=0 ClearanceFlags=82 CtCur=CLEARANCE_NONE WaypointNext=0 AltCleared=-1 HdgAssigned=-1 SquawkAssigned=4608 LandingSequence=LANDING_NONE DepartureRequest=DEPARTURE_VFR_REQUEST_NONE ParkingRequest=PARKING_NAME_NONE ParkingTypeRequest=PARKING_TYPE_NONE PatternLeg=PATTERN_LEG_NONE ApproachIndex=-1 ApproachTransitionIndex=-1 ApproachRequestIndex=-1 ApproachTransitionRequestIndex=-1 RunwayIndex=-1 RunwayRequestIndex=-1 ParkingIndex=-1 FlightFollowing=FLIGHT_FOLLOWING_NO AirspaceTransition=AIRSPACE_TRANSITION_NONE BVAirspaceTransition=BV_TYPE_NONE BVAirspaceTransitionReq=BV_TYPE_NONE TakeoffSequence=TAKEOFF_SEQUENCE_NONE LandingSequenceNumber=-1 TaxiRouteCurrent=-1 CruisingAltitude=-1 RequestedCruisingAltitude=-1 ExpectedAltitude=-1 AircraftSignature=1,0 [ATC_AircraftManager] NumberofAircraft=1 [ATC_MessageSystem] FrequencyNodes=0 [DateTimeSeason] Season=Summer Year=2019 Day=327 Hours=16 Minutes=00 Seconds=00 UseZuluTime=False [SimVars.0] Latitude=N51° 30' 17.81" Longitude=E0° 3' 51.71" Altitude=+000019.00 Pitch=0 Bank=0 Heading=-87.106811609119191075 PVelBodyAxis=0 BVelBodyAxis=0 HVelBodyAxis=0 XVelBodyAxis=0 YVelBodyAxis=0 ZVelBodyAxis=0 SimOnGround=True OnPlatformHeight=-9999999999 [Avionics.0] Comm1Active=124.850 Comm1Standby=124.850 Comm2Active=124.850 Comm2Standby=124.850 Comm3Active=124.850 Comm3Standby=124.850 Nav1Active=110.50 Nav1Standby=113.90 OBS1=360 Nav2Active=110.50 Nav2Standby=113.90 OBS2=360 Transponder=1234 ADFActive=890 ADF2Active=890 DMESelected=1 ComTransmit=1 ComReceiveBoth=False Com1Receive=True Com2Receive=False Com3Receive=False AudioNav1Listen=False AudioNav2Listen=False AudioMarkerListen=True AudioDmeListen=False AudioAdfListen=False AudioAdf2Listen=False AvionicsSwitch=True [Slew.0] Active=False [Freeze.0] Location=False Altitude=False Attitude=False [Engine Parameters.1.0] ThrottleLeverPct=0 PropellerLeverPct=0.99993896484375 MixtureLeverPct=0.99993896484375 Pct Engine RPM=0.25 MaxReachedEngineRPM=2018.3370438323020153 LeftMagneto=True RightMagneto=True GeneratorSwitch=True CowlFlapPct=0 FuelPumpSwitch=False CarbHeat/DeiceSwitch=False EngineMasterSwitch=True GlowPlugTemperaturePct=1 [Propeller.1.0] prop_beta=0.34906585039886589561 prop_max_rpm_percent=0 [Fuel.0] TankSelector=All TankSelector1=All Center=100 LeftMain=90 RightMain=90 LeftAux=100 RightAux=100 LeftTip=100 RightTip=100 Center 2=100 Center 3=100 External 1=100 External 2=100 [Systems.0] BatterySwitch=True StructuralDeiceSwitch=False PropDeiceSwitch=False Autobrakes=0 StandbyVacuum=False PropSync=False AutoFeatherSwitch=False FlightDirector=False PanelLights=False LaunchBarSwitch=False LaunchBarState=0 TailhookHandle=False TailhookState=0 FoldingWingsHandle=False FoldingWingsState=0, 0 [Gauges.0] KollsmanSetting=29.921342849731445313 [BleedAir.0] BleedAirSource=0 [Switches.0] PitotHeat=False BeaconLights=True LandingLights=False LogoLights=False NavLights=False PanelLights=False RecognitionLights=False StrobeLights=False TaxiLights=False WingLights=False CabinLights=False GlareshieldLights=False PedestalLights=False [AutoPilot.0] MasterSwitch=False WingLeveler=False Nav1Lock=False HeadingLock=False HeadingValue=0 AltitudeLock=False AltitudeValue=0 AttitudeHold=False AirspeedHold=False AirspeedValue=0 MachHold=False MachValue=0 VerticalSpeedHold=False VerticalSpeedValue=0 RPMHold=False RPMValue=0 GlideslopeHold=False ApproachHold=False BackCourseHold=False YawDamper=False ToGa=False AutoThrottleArm=False ``` -------------------------------- ### Flight Simulator Example Source: https://docs.flightsimulator.com/html/Content_Configuration/Models/Model_Examples This example demonstrates a block that checks if a parameter 'STATE0_TIMER' exists and is greater than 0. If true, it calls the 'ASOBO_GT_Update' template. ```XML STATE0_TIMER 0 True (#SWITCH_POSITION_TYPE#:#SWITCH_POSITION_VAR#) 0 == if{ 1 (>#SWITCH_POSITION_TYPE#:#SWITCH_POSITION_VAR#) } ``` -------------------------------- ### Sim.cfg Example for Living Thing Variations Source: https://docs.flightsimulator.com/html/Content_Configuration/SimObjects/Living_Things/Living_Things_sim_cfg This code snippet demonstrates the structure of the [fltsim.N] section in a sim.cfg file, showing how to define different variations for a living thing. It includes parameters for title, model, texture, animation, and sound, with examples of how to specify variations by appending text to default folder names. ```config [fltsim.0] title=MyCompany_Crab model="" texture="" [fltsim.1] title=MyCompany_Crab_Red model="Red" ; folder would be "model.Red" texture="Red" ; folder would be "texture.Red" ``` -------------------------------- ### Calling an RTC in Mission Intro (XML) Source: https://docs.flightsimulator.com/html/Content_Configuration/Cameras/RTC/RTC_Definition_Examples Illustrates how to initiate an RTC sequence at the beginning of a mission. This example shows a FlowStateAction that sets up initial conditions and then calls a specific RTCSequencer. It references multiple object IDs for actions and states. ```XML True INTRO Generic_CommercialFlight_Intro False True ``` -------------------------------- ### C# SimConnect Client Setup (.NET) Source: https://docs.flightsimulator.com/html/Programming_Tools/SimConnect/Programming_SimConnect_Clients_using_Managed_Code Demonstrates the necessary using statements for a C# SimConnect client. Requires .NET Framework 4.7 and a reference to Microsoft.FlightSimulator.SimConnect. ```csharp using Microsoft.FlightSimulator.SimConnect; using System.Runtime.InteropServices; ``` -------------------------------- ### XML: Allow Zero EntryWeight if Total Weight is Non-Zero Source: https://docs.flightsimulator.com/html/Content_Configuration/Environment/Living_World/Living_World_Config/Living_World_Configuration_Examples This XML example shows that an EntryWeight of 0 is permissible for a ContainerEntry, as long as the total accumulated weight of all entries in the list is not zero. This allows an object to be excluded from random selection while maintaining valid configuration. ```xml ``` -------------------------------- ### Flight Control PID Parameters Example Source: https://docs.flightsimulator.com/html/Content_Configuration/SimObjects/Aircraft_SimO/AI_Config_Definition Illustrates example PID values for controlling aircraft behavior during flight. These PIDs manage throttle, pitch, roll, heading, and vertical speed to maintain target parameters. ```plaintext throttlePID = 20.0, 0.3, 20.0, 20.0, 500.0 pitchPID = 1.0, 0.01, 2.0, 0.6, 5.0 rollPID = 1.0, 0.001, 1.0, 0.5, 8.0 headingPID = 1.0, 0.01, 1.0, 1.0, 20.0 verticalSpeedPID = 0.5, 0.1, 0.5, 200.0, 5000.0 nav_ex1PID = 3.0, 0.01, 2.0, 0.035, 50.0 nav_yawPID = 0.02, 0.00006, 0.006, 0.3, 3.0 glideSlopePID = 5.52, 1.0, 3.0, 2.0, 60.0 flightLevelPID = 10.0, 1.0, 10.0, 100.0, 1000.0 ``` -------------------------------- ### Aircraft Configuration File Example (*.cfg) Source: https://docs.flightsimulator.com/html/Additional_Information/File_Formats/CFG_Files An excerpt from an aircraft.cfg file demonstrating the basic structure of sections and parameters. ```cfg [VERSION] major = 1 minor = 0 [GENERAL] atc_type = "MyManufacturer" atc_model = "Simple" Category = "airplane" performance = "" ``` -------------------------------- ### RTCSequencer with GUID InstanceId Source: https://docs.flightsimulator.com/html/Content_Configuration/Cameras/RTC/Using_RTCs This XML example shows an RTCSequencer with a GUID assigned to the InstanceId field. This is necessary when replacing an existing RTCSequencer to ensure proper overriding. ```xml RTC_Airport_Intro ``` -------------------------------- ### soundai.xml Structure and Example Source: https://docs.flightsimulator.com/html/mergedProjects/How_To_Make_An_Aircraft/Contents/Audio/Audio_For_AI_Aircraft This XML snippet demonstrates the structure of a typical soundai.xml file for AI aircraft. It includes Wwise package information and engine sound presets, mapping SimVars to Wwise events and Real-Time Parameter Controls (RTPCs). ```xml ``` -------------------------------- ### Microsoft Flight Simulator XML Configuration Example Source: https://docs.flightsimulator.com/html/Additional_Information/File_Formats/XML_Files An example of an XML file used in Microsoft Flight Simulator, showcasing the structure with declarations, elements, attributes, and comments. This file defines a flight challenge with various actions. ```xml RTC_Challenge True False ``` -------------------------------- ### Define Wwise Packages (XML) Source: https://docs.flightsimulator.com/html/Content_Configuration/Sounds/Sound_Examples Specifies the Wwise packages to be loaded. This includes a main package and potentially additional packages. If not defined, the package name is inferred from the sound.xml file path. This is a structural definition for Wwise integration. ```xml ``` -------------------------------- ### Configure a Flight Sim Contact Point (Example) Source: https://docs.flightsimulator.com/html/Content_Configuration/SimObjects/Aircraft_SimO/flight_model/contact_points Example demonstrating how to define a single contact point using 17 comma-separated values. The first value specifies the contact point type (e.g., wheel, float), followed by positional data, physical properties, and operational parameters. Ensure the number of defined points matches `max_number_of_points` for aircraft validity. ```text point.0 = 1, -13, 0, -0.65, 750, 0, 0.523, 90, 0.296, 2.5, 0.794, 0, 0, 0, 165, 165, 1 ``` -------------------------------- ### Configure SimVar Sounds with Ranges (XML) Source: https://docs.flightsimulator.com/html/Content_Configuration/Sounds/Sound_Examples This example illustrates how to use the `` element to play sounds based on SimVar values. It shows how to trigger sounds when a SimVar changes, or when its value falls within specific ranges (e.g., between 10 and 15, or above 25). ```XML ``` -------------------------------- ### Configure Loading Screen Images and Tips Source: https://docs.flightsimulator.com/html/Content_Configuration/SimObjects/Aircraft_SimO/aircraft_cfg Sets images and accompanying text tips displayed during free flight loading. Supports PNG or JPEG images and localizable, category-specific tips. ```config Tips0=TT:LOADING.TIPS.AIRCRAFTNAME_000 Tips1=TT:LOADING.TIPS.AIRCRAFTNAME_001 Tips2=TT:LOADING.TIPS.AIRCRAFTNAME_002 ``` -------------------------------- ### Base Template for Lighting Interactions Source: https://docs.flightsimulator.com/html/Content_Configuration/Models/ModelBehaviors/TemplateExplorer/Asobo/Common/Lighting Provides a foundational template for setting up various lighting interactions within the simulator. It establishes common parameters such as input event IDs and WWise prefixes, leveraging a base interaction template for unified input handling. ```xml ``` === COMPLETE CONTENT === This response contains all available snippets from this library. No additional content exists. Do not make further requests.