FSDeveloper Wiki - User contributions [en-gb]

Flight file (MSFS)

2023-05-21T11:45:16Z

Mr LiamT: Updated for the newest version of the simulator. Tweaked page structure.

Mission Creation for MSFS

2023-05-21T10:41:18Z

Mr LiamT: Updated for the newest version of the simulator and the SimpleMission sample project. Improved structure and writing style.

[[Category:Missions]]

{{:Ambox-Content-WIP}}

{{Infobox-Applicable-FSVersion
| MSFS = true
| FSXI = false
| P3D5 = false
| P3D4 = false
| P3D3 = false
| P3D2 = false
| P3D = false
| FSW = false
| FSXSE = false
| FSXA = false
| FSX = false
| FS2004 = false
| FS2002 = false
| XP11 = false
| XP10 = false
| XP9 = false
}}

== Overview ==
Creating a mission involves using different tools and skills. While it may be challenging to get your first mission up and running, once you understand the basic rules and files that make up a mission, the possibilities are endless. Essentially, a mission is a scripted set of events that tells a story, ranging from exciting scenarios like mountain rescues or engine problems to simpler flights with interesting points along the way.

To turn your mission idea into a playable experience, you need to plan the mission flow and then code it. Start by outlining the flow on paper, showing how the mission progresses from start to finish. Next, select and use triggers and actions to create the mission's logic. Triggers check for conditions or events, while actions allow you to modify and control various aspects of the mission. You can also use objectives to give the player a clear sense of direction and purpose. Once you've scripted your mission, you can fine-tune and test it using the script editor, console for error checking, and tools for finding and fixing problems.

With patience and creativity, you can create rewarding and enjoyable missions that captivate players and keep them coming back for more!

== Come up with a scenario and story ==
You need to decide what kind of mission you want to create, for example, a tutorial, an emergency scenario, or a treasure hunt.
You also need to think of how the mission will progress from start to finish.
* How will you introduce the player to the mission and explain their role and objective?
* What will you reveal to the player and what will they have to discover on their own?
* What are the possible ways that the player can complete the mission? Are there branching paths or different outcomes?
* How will you end the mission and give feedback or rewards to the player?
It can help to have a written structure that outlines your mission in detail. You can follow the same three-stage layout as a screenplay. This gives you a clear and coherent way of telling your story.
* The first section is your introduction, where you need to capture the player’s interest and set up the context and premise of the mission.
* The second section is where you trigger an event that challenges the player and makes them react (for example, an engine failure, a storm, or an enemy attack).
* The third section is where you conclude the mission and let the player reflect on their performance and enjoy their success (or failure).
* You can also add some twists or surprises along the way.

=== Give your players the freedom to choose their own path ===

You can also provide different threads or options for each section, depending on the player’s choices or actions. This will make your mission more dynamic and replayable, as the player can try different approaches or strategies. You can make your mission react to the player’s choices by changing the dialogue, the environment, or the difficulty. You can also use choke-points to connect your sections and keep your mission consistent. Choke-points are specific locations or conditions that mark the end of one section and the start of another. For example, in your introduction, the choke-point could be reaching the head of the valley. No matter which path the player took, they have to reach that point to trigger the next section. Choke-points help you keep track of your mission progression and avoid inconsistencies or errors. They also help you create different combinations of sections and options. For example, if you have three sections, each with three options, you can have nine different ways of flying a single mission.

== Turn your story into a mission ==
Now for the most fun part you will make your idea into a real mission that you can play.
First, you need to plan the flow of the mission. This means how the mission goes from start to finish. You can use paper and a pencil to draw the flow. This will help you see the logic of the mission without worrying about coding.
For example, let’s say your mission has these steps:
# You take off from the airport.
# You hear some speech after 30 seconds.
# You have three ways to get to point B, where the next part of the mission starts.
You can draw three boxes on the paper and write the steps inside them: 'Takeoff', 'Speech', and 'At point B'. The speech should happen 30 seconds after takeoff, so note that down next to the Speech box. Then you can draw three lines from the “Speech” box to the “At point B” box. These are the three paths the player can follow. On each line, you can write what you need to do: disable the other two paths and enable the next part of the mission.

Now that you have a good map of your mission flow, it will be easier to code it later.

=== Actions and triggers ===

Next, you need to choose the elements you will use to turn your mission map into code. The main elements of a mission are [[MSFS_Mission_Script_-_Actions|Actions]] and [[MSFS_Mission_Script_-_Triggers|Triggers]]. These elements let you check things and do things in your mission. For example, you can check if the player is flying high or low, or if they are in a certain area. You can also do things like play speech, activate or deactivate objects, or change the difficulty.

To keep the example going, you might have a [[Property Trigger]] checking "Altitude AGL > 10" to test for takeoff. That would start a 30-second [[Timer Trigger]] using an [[Object Activation Action]] which, in turn, would call a [[Dialog Action]] for your "Speech" box. You would need one Trigger per potential path; they might be set to detect altitude, or heading, or more likely that the player has entered an area. Each of those would need another [[Dialog Action]] (just to keep the player informed), an [[Object Activation Action]] to enable the Trigger that checks "At Point B" and another [[Object Activation Action]] to disable the other two paths.

== Create a mission project ==
=== Start with the SimpleMission sample project ===
You can use the SimpleMission sample project. [https://flightsim.to/file/23934/mission-creation-resources Download it] and complete [[SimpleMission_(MSFS)#Step_1:_Download_the_SimpleMission_project|step 1 and 2 of the guide]].

== Decide on flight conditions ==
Next, you will have to configure the flight conditions. To start, you can create a [[flightplan (MSFS)|flight plan]] in the worldmap or with [[Little Navmap]]. This flight plan will be shown to the player when the mission starts, so it shouldn't spoil the unexpected parts of the flight (e.g., an emergency).

Then you decide on the starting point of the mission (e.g., at the beginning of the flight or in the air somewhere along the route).

=== [[Flight_file_(MSFS)|Create the flight file]] ===
# Load your flightplan and pick your starting location in the worldmap.
# Select your aircraft, livery, fuel, payload, and atc options.
# Choose your time, weather preset, and the multiplayer and traffic settings.
# Load your flight.
# Set up your aircraft as you want it (lights, switches, autopilot, etc.).
# You can customize the weather and save it as a preset.
# Position your plane exactly where you want it, with the correct speed and trim settings.
# Pause the game and save the flight as a <code>.FLT</code> and as a <code>.PLN</code>.
# Move your flight file and flightplan to the mission folder in PackageSources.

You will need to [[Flight_file_(MSFS)#Creating_your_flight_file|manually edit the .FLT]] to choose the assistance preset, mission category, traffic, briefing and loading screen. You can use the .FLT in the [https://flightsim.to/file/23934/mission-creation-resources SimpleMission project] as a reference.

==== Add pictures ====
Add pictures for your mission thumbnail, and the loading, briefing, and ending screens. The names for the loading an briefing pictures are defined in the [[Flight_file_(MSFS)#Pictures|.FLT file]]. The thumbnail will need to be named: <code>Activity_Widget.jpg</code> and the endscreen picture will need to be named: <code>rewardscreen.jpg</code>. You can use the pictures in the [https://flightsim.to/file/23934/mission-creation-resources SimpleMission project] as a reference.

=== [[Weather definitions (MSFS)|Define custom weather]] ===
# Change the weather with the weather panel during flight.
# Save it as a new preset.
# Find the .WPR file in <code>\AppData\Roaming\Microsoft Flight Simulator\Weather\Presets\</code>.
# Move it mission folder (next to the .flt) and rename it to <code>Weather.WPR</code>.
# Tweak the preset by editing the .WPR file in Notepad++. See [https://docs.flightsimulator.com/html/Content_Configuration/Flights_And_Missions/Weather_Definitions.htm the documentation].

== Set up a [[:Category:MSFS Mission Script|mission script]] ==
Continue with the [https://flightsim.to/file/23934/mission-creation-resources SimpleMission sample project] and complete [[SimpleMission_(MSFS)#Step_3:_Open_the_project_folder|step 3 of the guide]].

== Code your mission ==
You need to turn your mission diagram into a mission script with the script editor. For everything that happens in your mission, you need to choose and add the correct triggers and link them to actions.

=== Script Building Blocks ===
There are different [[Category:MSFS_Mission_Script#Building_blocks|types of nodes]] that you can use to make your mission.

==== [[MSFS Mission Script - Triggers|Triggers]] & [[MSFS Mission Script - Actions|Actions]] ====
Triggers and actions are fundamental components of a mission, working together to create an engaging experience. Triggers act as checkpoints, monitoring events or conditions, while actions determine what happens when those conditions are met. Triggers check for specific events or conditions, activating actions that perform tasks like activating objects, adjusting timers, displaying messages, playing sounds, and modifying goals. By combining triggers and actions, mission creators can script the flow and behavior of the mission, crafting interactive experiences for players.

==== [[MSFS Mission Script - Mission objects|Mission objects]] ====
Mission objects define a range of things like mission type, goals, world traffic, and a custom camera.

==== [[MSFS Mission Script - Calculator|Calculators]] ====
You can use calculators for more advanced logic in your mission. It can take in multiple variables and trigger different actions based on a logic. You can also use this to calculate a mission score and probably many more applications which you can explore.

{{blockquote|1='''[[:Category:MSFS_Mission_Script#Building_blocks|Look here for a complete overview of objects.]]'''}}

=== Script editor ===
To turn your mission map into a mission script, we will use the script editor. It allows you to create the mission with a visual representation of the script. All building blocks of the mission – such as triggers and actions – are represented by nodes (also called '''''mission objects'''''). Each node contains some settings specific to the building block and can be connected to other nodes. Nodes have ingoing and outgoing connections. Connections on the right size are references to other nodes and connections on the left size means the node is referenced by other nodes.

[[File:BasicMissionNodes.png|700px|thumb|left|Some of the nodes of a basic mission]]<br clear=all>

=== Loading a script ===
To start using the script editor, open the mission project, select your mission asset group, and click load in editor:

[[File:OpenScriptEditor.png|500px|thumb|left|How to open the script editor]]<br clear=all>

=== Adding objectives to your mission ===
Once you have loaded a script in the script editor, you can start adding objectives to your mission. Objectives are the goals that the player needs to achieve or avoid to complete the mission. They also provide feedback and guidance to the player during the mission.

Each objective has a state that shows how the player is doing:
* ''Completed:'' The player completed the objective.
* ''Failed:'' The player failed the objective.
* ''Aborted:'' The player aborted the objective.

If any ''mandatory'' objective is Failed or Aborted, the mission ends with a popup and a short message. If all ''mandatory'' objectives are Completed, the mission ends with a debriefing and a reward screen.

By default, all objectives are ''mandatory''. If you don't want this, set the objective to be ''Optional''. The player can skip or fail optional objectives without ending the mission. But they still show up in the objectives panel, so the player can try them if they want.

To use objectives, you need to link each to a [[MSFS_Mission_Script_-_Mission_objects#Goals|Goal or SubGoal node]]. The goal node determines the state of the objective it is linked to. You also set the initial state in the goal node. To change the state during the mission, you need to use a [[(Sub)Goal_Resolution_Action|(Sub)GoalResolutionAction]].

==== Steps ====
You can also add steps to your objectives. Steps are smaller tasks that help the player complete the objective. They show up in the objectives panel too:

[[File:ObjectivesPanel.jpg|500px|thumb|left|View of objectives and steps in the objectives panel]]<br clear=all>

=== Comments ===
As you create your mission script, you may want to add some comments in the script editor. Comments are nodes that you can add in the script editor to explain what each node or connection does. They can help you organize your script and make it easier to understand and edit later. Comments are not part of the mission script and do not affect how it works. They are only visible in the script editor.

[[File:CommentNodes.png|500px|thumb|left|Comment nodes used to show the working of a block of nodes]]<br clear=all>

=== Placing objects in the world ===
You can precisely place objects in the world using the script editor and the gizmo. First, [[#Testing_the_mission|compile and start your mission]]. When the world is loaded, you can add different kinds of objects:
* [[MSFS_Mission_Script_-_Areas|Areas]], for use in [[Proximity_Trigger|proximity triggers]].
* Static scenery objects with [[MSFS_Mission_Script_-_Library_Objects|library objects]].
* [[MSFS_Mission_Script_-_Sim_Objects|Simobjects]], using containers or flocks.
* [[MSFS_Mission_Script_-_Areas#InGameMarker|Markers]] and [[MSFS_Mission_Script_-_Mission_objects#PointOfInterest|POI's]].
* [[MSFS_Mission_Script_-_Mission_objects#Racing_.2F_Multiplayer|Race points]].
* A custom [[MSFS_Mission_Script_-_Mission_objects#Camera|camera]].
* A landing zone for [[MSFS_Mission_Script_-_Mission_objects#List_of_Mission_Types|landing challenges]].
* A [[MSFS_Mission_Script_-_Calculator#List_of_parameter_types|path for a calculator]].

If the object has a [[World_position_(MSFS)|world position]], it will spawn in the middle of your view.

To change the location, you can move the object with the Gizmo. For gizmo options, in the script editor click <code>View > Gizmo</code>.

With the Developer Camera enabled you can double click on the objects in the script editor and the camera will go to their location.

[[File:MissionGizmo.jpg|700px|thumb|left|Area with gizmo and gizmo options]]<br clear=all>

== Test, optimize, and debug your mission ==
In this section, you will learn how to test, optimize, and debug your mission. You will use the script editor and other tools to check for errors and fix problems in your mission script.

=== Testing the mission ===
The first step to test your mission script is to compile the mission. Compiling the mission means turning your script into a file that can be loaded and played by MSFS. When you build your project, the mission will get compiled and turned into an .SPB file.

==== Console ====
The [https://docs.flightsimulator.com/html/Developer_Mode/Menus/Debug/The_Console.htm console] is where you can see the results of compiling the mission. It shows you any errors or warnings in your script. You need to fix any errors before you can play your mission. Warnings are not critical, but they may indicate potential problems or improvements in your script.

==== Start the mission ====
When your script has successfully compiled, you can start the mission. To do that, go to custom activities and select your mission.

=== Loading and updating your mission elements ===
With the script editor open you can see if the elements are loaded in the mission. To add elements, click the plus in the overview window and select the element you want to add.

If the names are white, they are loaded, but if they are red, it means they are not loaded. While working on your mission, you can update the elements by clicking <code>Script Editor > Game > Update</code>.

[[File:ScriptEditorOverview.png|400px|thumb|left|Script object overview]]<br clear=all>

=== World objects debug ===
When the mission is loaded in, make sure <code>Debug > World Objects</code> is enabled. Now you will see your areas and waypoints overlayed in the world.

=== Debugging calculators ===
You can debug [[MSFS_Mission_Script_-_Calculator|calculators]] by enabling *DisplayAllowed* and using <code>Options > Flight Object Debug</code>. Now you can see the parameters and actions of your calculator in real time.

=== Managing triggers ===
You will use many triggers in your mission, but you need to control when they are active. Otherwise, they may fire at the wrong time and cause problems or confusion.

For example, imagine you have a trigger that tells the player off if they fly too low during cruise. You don’t want this trigger to fire when the player is landing, because they have to go down to the runway. That would be confusing and annoying.

To avoid this, you need to activate and deactivate triggers at the right moments. Most triggers should start inactive and become active with an [[Object_Activation_Action|ObjectActivationAction]] when the previous trigger in the mission’s flow has fired. You should also use an [[Object_Activation_Action|ObjectActivationAction]] to deactivate them when they are not needed anymore.

[[File:MissionFlowchartTrigger.png|600px|thumb|left|A trigger to warn the player of a low altitude has to be active at the appropriate time]]<br clear=all>

Triggers have a property called OneShot. If you enable this property, the trigger will deactivate itself after it has fired. This can save you some time and nodes, but be careful not to use it for triggers that you want to fire more than once.

=== Unconnected nodes ===
You can use the script editor to look for breaks in your mission logic. All nodes that aren't referenced by another node are marked with a white dot.

If nodes are 'isolated' like this, they may not function as expected.
* Actions that are never referenced won't execute.
* Triggers that aren't referenced by a [[Object_Activation_Action|ObjectActivationAction]] aren't properly managed.
* For some nodes, such as the main [[MSFS_Mission_Script_-_Mission_objects#Defining_the_mission_type|mission object]], this isn't an issue.

[[File:Script editor example.jpg|300px|thumb|left|Script object overview]]<br clear=all>

== Exporting the mission ==
To compile the mission for export, click <code>Clean All</code>, then <code>Build All</code>. Make sure there are no errors in the console from the building process. Then click <code>Build & Export</code>, ensure the mission package is checkmarked, choose <code>Community Publishing</code>, and select the Export Directory.

== Conclusion ==
I hope you enjoyed this tutorial and found it useful. Creating a mission is a complex and creative task that requires a lot of skills and patience. But it is also very rewarding and fun. You can make any kind of mission you want, from tutorials to emergencies to adventures. You can give your players the freedom to choose their own path and make your mission dynamic and replayable.

If you want to learn more about creating missions for MSFS, you can check out these pages:
{{Template:Navbox-Mission-Creation-MSFS}}

MSFS Mission Script - Mission objects

2023-05-21T10:38:55Z

Mr LiamT: /* Calculator */ Delete headings and add explanation

MSFS Mission Script - Actions

2023-05-21T10:28:55Z

Mr LiamT: Add a short summary to te beginning of the page

[[Category:MSFS_Mission_Script]]

{{:Ambox-Content-WIP}}

{{Infobox-Applicable-FSVersion
| MSFS = true
| FSXI = false
| P3D5 = false
| P3D4 = false
| P3D3 = false
| P3D2 = false
| P3D = false
| FSW = false
| FSXSE = false
| FSXA = false
| FSX = false
| FS2004 = false
| FS2002 = false
| XP11 = false
| XP10 = false
| XP9 = false
}}

Actions are mission functions that perform various tasks, such as activating objects, executing code, controlling timers, playing sounds, triggering events, and shaping the flow of the mission.
{{:Transclusion_MSFS_Mission_Script}}

== Action queue ==
All actions are fired in the order they’re listed in the ObjectReferenceList of the trigger that fired. This is important, because Dialog actions take time to play and will delay any actions that follow them. If a delay is set on a Dialog action, then the next action in the queue will be delayed by that amount. You can arrange the order in which actions in a given queue fire by changing the order manually in the .xml.

== Common actions ==
[[Object Activation Action|ObjectActivationAction]], [[Dialog Action|DialogAction]], [[Change Assistance Item Action|ChangeAssistanceItemAction]], [[Failure Action|FailureAction]], [[Adjust Payload Action|AdjustPayloadAction]], [[Refill Action|RefillAction]], [[MSFS_Mission_Script_-_Flow_states#FlowStateAction|FlowStateAction]].

== General attributes ==
Actions have a few general attributes:
=== Immediate ===
'''False:''' This action will wait for prior action in the action queue to complete. The order is determined by the order the actions are listed in the trigger. This can be changed by manually editing the order in the '''Actions''' section of the element in the mission .xml.<br>
'''True:''' This action will ignore the action queue and start immediately.

=== BreakOnExecute ===
Official description: "Code break if action is executed". Not sure what that means
=== TargetPlayer ===
The target player refers to the target of an action in a multiplayer mission. Action Target can be the GUID of a particular player or team, or you can use one of the specially defined guids to refer to relative targets:
{| class="wikitable"
|Local User
|{8B7615FA-BBBF-4baa-B959-5EF4F59BB575}
|-
|All Players
|{D09ADD85-4CA8-4be9-939C-4544BA259DA2}
|-
|Trigger
|{9A82F89B-F271-4285-AE90-1F733945D975}
|-
|All Players Except Trigger
|{D2764AC8-FBB3-4b9b-9721-3C3EA0CB402B}
|}

== Mission logic ==
==== [[Object Activation Action|ObjectActivationAction]] ====
Very useful action to (de)activate objects such as triggers and InGameMarkers.
==== [[Random_Action|RandomAction]] ====
Randomly executes one action from a list. First, the action has a probability that any action is executed at all. If it does execute, it randomly chooses one action that will execute.

==== ExecuteRPNAction ====
Execute RPN code.
==== SkipAction ====
Skip an action.
==== StopObjectActionQueueAction ====
Stop action queues of referenced objects
==== ExecuteListAction ====
Execute a list of action
==== WaitAction ====
Action that does nothing... for a predefined time. You can use this to delay the next items in an actionQeue.

== Actions related to a trigger ==
==== [[Count Action|CountAction]] ====
Changes the count of a [[Counter_Trigger|CounterTrigger]]
==== [[Reset Timer Action|ResetTimerAction]] ====
Reset the timer to the StartTime.
==== [[Timer Adjust Action|TimerAdjustAction]] ====
Adjusts the time of a [[Timer Trigger|TimerTrigger]] up or down.

== Action related to [[MSFS Mission Script - Mission objects|Mission objects]] ==
==== [[(Sub)Goal_Resolution_Action|GoalResolutionAction & SubGoalResolutionAction]] ====
Changes the state of a [[MSFS_Mission_Script_-_Mission_objects#Goals|(sub)goal]].
==== [[Grant Reward Action|GrantRewardAction]] ====
Untested.
==== [[Point Of Interest Activation Action|PointOfInterestActivationAction]] ====
(De)activates a [[point of interest]]
==== POIChangeModelAction ====
Unknown.

== Sound ==
==== [[Dialog Action|DialogAction]] ====
Plays dialog for the copilot and atc. It can use sound files or text-to-speech (TTS). The dialogAction can also show subtitles.
==== InstructorDialogAction ====
Same as a DialogAction, but allows for a male and female voice, depending on the player's selected instructor in the settings.
==== OneShotSoundAction ====
Plays specified sound file. Doesn't seem to work in MSFS.
==== PlayListAction ====
Plays through a list of sound files. Doesn't seem to work in MSFS.
==== PlaySoundAction ====
Play a sound in 3D space. Uses a WWise event.
==== StopSoundAction ====
Stop a sound.
==== SoundEffectAction ====
Sets sound effects. Doesn't seem to work in MSFS.
==== RTPCAction ====
Send a WWise RTPC.

== Player/Aircraft ==
==== [[Change Assistance Item Action|ChangeAssistanceItemAction]] ====
Changes specific assistance items throughout the mission.
==== [[Failure Action|FailureAction]] ====
Fail a system (e.g., fuel pump, gear, altimeter, radios).
==== [[Adjust Payload Action|AdjustPayloadAction]] ====
Set or adjust the weight on a payload station (weight of pilot, passengers, baggage, etc).
==== [[Refill Action|RefillAction]] ====
Add or subtract percent of a substance (e.g., fuel).
==== ChangeObjectTypeAction ====
Change an object to a different type.
==== [[Request Teleport Action|RequestTeleportAction]] ====
Request a teleport.
==== RequestTeleportCameraAction ====
Teleport current camera to a position given in a CFG file (e.g, close instrument view, wide cockpit view, gear view).
==== SkipTimeAction ====
Very cool action allowing you to speed up or skip time without affecting the simulation. It will speed up cloud movement and the day-night cycle, but keep the planes, other vehicles, and animations at the normal speed.

== Action related to AI / Simobjects ==
==== [[AI Take Controls Action|AITakeControlsAction]] ====
Changes control of the users' plane between user and AI.
==== [[Send Message To AI Action|SendMessageToAIAction]] ====
Currently useless for missions. See [https://docs.flightsimulator.com/html/Content_Configuration/Environment/Living_World/Airport_Services/Service_And_IdleWorker_Script_Definitions.htm?rhhlterm=sendmessagetoaiaction#h2 documentation].
==== [[Activate Waypoints Action|ActivateWaypointsAction]] ====
Send waypoints to a [[Simobject]] for the AI to follow.
==== WaypointsFromAnotherWaypointAction ====
Get waypoint list for another ActivateWaypointsAction.
==== PlayFlightRecordingAction ====
Plays back recording for the [[MSFS_Mission_Script_-_Sim_Objects#AirplanePlaybackAI|AirplanePlaybackAI]].

==== SpawnAction ====

== [[MSFS_Mission_Script_-_Flow_states|Flowstate]] ==
==== FlowEventAction ====
==== FlowStateAction ====
==== TimerTriggerFlowStateAction ====
==== TransitionAction ====
==== ToggleVisibilityAction ====

== [[MSFS_Mission_Script_-_Events|Event]] ==
==== EventTriggerActivationAction ====
==== EventTriggerAction ====
==== EventAction ====

== Animation / effects / RTC ==
==== [[Fade To Color Action|FadeToColorAction]] ====
Fades a color over the whole viewport. Useful for teleports and testing.
==== AttachEffectAction ====
Attach a visual effect to an object (e.g., plane, simobject).
==== PlayAnimationAction ====
Play an animation.
==== PlayBlendTreeStateAction ====
Play a blend tree state.
==== RTCLocationsPreloadAction ====

== Replay ==
==== RecordReplayAction ====
Record a new replay and store in file.
==== PlayReplayAction ====
Play a replay file.
==== PlayGhostAction ====
Play a ghost replay.

== Race ==
==== DisqualifyPlayerAction ====
Disqualify a player.
==== RaceCourseActivateAction ====
Enable race course progress for all players.
==== RaceClockStartAction ====
Start the global race timer for all players.
==== TimePenaltyAction ====
Give a player a time penalty/bonus.
==== BackOnTrackAction ====
When a crash occurs in a race course, the crash is 'not allowed' and the player is teleported to the pylon before his crash.

== Other ==
==== FocusInstrumentAction ====
Focus the camera on a specific instrument. You can highlight the instrument as well (blue glow).

==== RumbleAction ====
Controller rumble effect.
==== CustomAction ====
Create a custom action that uses an external program connected with simconnect.
==== ChangeMarkerTemplateAction ====
Change marker template.
==== ChangeRopeLinkAction ====
Change link on ropes.
==== ChangeNodeAction ====
Change node property (e.g. hide the yoke).

==== AttachDroppablePayloadAction ====
Attach a droppable payload.
==== AgentMessageAction ====
Send or reveive a message from an agent (ATC?).
==== MissionScoreToLeaderboardAction ====
Try to send mission score to leaderboard. Not (yet) supported for unofficial missions.
==== ShowLogbookAction ====
Show the logbook.
==== FilterInputKeyAction ====
Change input key processing (e.g. turn of the input key for the elevator).

{{Template:Navbox-Mission-Creation-MSFS}}

SimpleMission (MSFS)

2023-05-16T20:05:14Z

Mr LiamT: Updated instructions for the new version of the sample project

SimpleMission (MSFS)

2022-04-29T21:34:48Z

Mr LiamT: /* Step 3: Open the project folder */ Remove old explanation

Mission Creation for MSFS

2022-03-03T11:43:03Z

Mr LiamT: Added/expanded chapter on mission coding

[[Category:Missions]]

{{:Ambox-Content-WIP}}

{{Infobox-Applicable-FSVersion
| MSFS = true
| FSXI = false
| P3D5 = false
| P3D4 = false
| P3D3 = false
| P3D2 = false
| P3D = false
| FSW = false
| FSXSE = false
| FSXA = false
| FSX = false
| FS2004 = false
| FS2002 = false
| XP11 = false
| XP10 = false
| XP9 = false
}}

== Overview ==
Creating a mission is a complex task involving a diverse use of tools & skills. Getting your first mission going is likely to cause you some headaches.

Still here? Good. Once you ''do'' have that first one running, the sky's your limit. That basic set of rules and files that make up a mission are always the same so once you've got those sorted, it's just a case of coming up with an idea and writing it.

At it's simplest, a mission is just a scripted set of events that tell some kind of story. It may be dramatic - mountain rescue, failing aircraft, poor weather. It could just as easily be a simple flight from A to B with you pointing out areas of interest along the way, or a completely abstract challenge like finding out how many times you can touch-and-go in a 747 in five minutes.

Technically speaking, there are two main classes of 'things' in a mission; Actions and Triggers. An Action makes something happen, and a Trigger checks to see if something's happened and calls an Action if it has. By stringing together Actions and Triggers, you tell your story.

You'll also need to prepare the conditions of your flight; what will be the plane, time, location, route, and weather of your mission? Are there other planes flying around or parked on the airport? And how much assistance will you give the player?

Lastly, your mission will need sound files for the mission speech and some text and images for the briefing, loading, and ending screens.

== Before coding ==
=== Come up with a basic storyline ===
The first step of creating a mission is coming up with a scenario and story. You can make a tutorial, emergency scenario, even a treasure hunt, but you will need to think of a mission progression. What is the start of the mission? What will you need to tell the player and what will they have to find out on their own? What are the possible ways to complete the mission? Are there branching paths? And of course, how will the mission end? Will the player receive a grade or reward?

It can help to have a written structure. Think of it as a screenplay, and follow the same three-stage layout.

The first section is your introduction. You need to get the player's interest, explain who they are and why they're there. You use the first bit to get everything set up so that when The Exciting Thing happens, they know why and what to do about it.

In part two, The Exciting Thing happens. It doesn't matter what it is, but assuming you have some kind of event to which the player is supposed to react, this part details what happens. Once they've managed to cope with the situation and get it under control, they move on to...

Part three, the conclusion. Having successfully dealt with the engine fire/squalling brats in the back seats/condor-strike, the player gets to reflect on what they've done and enjoy the feeling of success for a little while. You could always throw in a last-minute plot twist of course.

Structuring like this gives you a tidy way of making your mission appear much more complex. You can easily provide different threads, or ways of achieving something, without too much extra effort. Let's say your Introduction sees the player getting from a bush strip to the head of a particular valley. You start with them following the river, simple enough. Later on, you could add the option to fly across the peaks and save time; as long as they reach the same head of the same valley, the rest of the mission isn't affected. If they've tried the mission before and failed, chances are they'll decide to try shortcuts anyway. Wouldn't it feel better if, having decided to cross the ridge instead of fly round, the mission reacts to that by saying "Hey, you're going over the ridge! A bit risky in this weather but the views will be stunning"? You can issue different Rewards, or maybe even alter how the next section plays out, depending on the path they took.

In short, you can see your mission sections as leading up to choke-points, such as the head of the valley. If you have three sections, each with three different ways of achieving it, that's nine different ways of flying a single mission.

=== Turn your story into a mission ===
Now comes the longest, and hopefully the most fun part; turning your idea into an immersive mission.

First, you have to clearly define the flow of the mission. You may find it easier to have a big sheet of paper and draw the mission out in pencil before you start coding. That lets you work out how it fits together logically without having to worry about whether or not you've got the spelling right.

For example, you know that after you take off you want to have some speech, and then there are three ways of getting from A to B, where the next section starts. OK, so that's three boxes to draw; 'Takeoff', 'Speech' and 'At point B'. The speech should happen 30 seconds after takeoff, so note that down next to the Speech box. Then you can draw three lines between 'Speech' and 'At Point B' to show the three paths, and the first thing to do on each path is disable the other two paths.

Already you've got a decent map of what happens in what order, and translating from these into actual mission-system code will be easier.

Read the list of possible [[MSFS_Mission_Script_-_Actions|Actions]] and [[MSFS_Mission_Script_-_Triggers|Triggers]], to find out what kinds of things you can check for and do. Try and spot a likely match for each of the boxes on your sheet of paper.

To keep the example going, you might have a [[Property Trigger]] checking "Altitude AGL > 10" to test for takeoff. That would start a 30-second [[Timer Trigger]] using an [[Object Activation Action] which, in turn, would call a [[Dialog Action]] for your "Speech" box. You would need one Trigger per potential path; they might be set to detect altitude, or heading, or more likely that the player has entered an area. Each of those would need another [[Dialog Action]] (just to keep the player informed), an [[Object Activation Action]] to enable the Trigger that checks "At Point B" and another [[Object Activation Action]] to disable the other two paths.

=== Create a mission project ===
==== Using the SimpleMission sample project ====
You can use the SimpleMission sample project. [https://flightsim.to/file/23934/mission-creation-resources Download it] and complete [[SimpleMission_(MSFS)#Step_1:_Download_the_SimpleMission_project|step 1 and 2 of the guide]].

=== Decide on flight conditions ===
Next, you will have to configure the flight conditions. To start, you can create a [[flightplan (MSFS)|flight plan]] in the worldmap or with [[Little Navmap]]. This flight plan will be shown to the player when the mission starts, so it shouldn't spoil the unexpected parts of the flight (e.g., an emergency).

Then you decide on the starting point of the mission (e.g., at the beginning of the flight or in the air somewhere along the route).

==== [[Flight_file_(MSFS)|Create the flight file]] ====
Load the flightplan and select the desired starting location in the worldmap. Now choose the aircraft, livery, fuel, payload, and atc options. Then choose the time, weather preset, and the multiplayer and traffic settings. Load the flight. Set up the aircraft how you want it (lights, switches, autopilot, etc.). You can customize the weather and save it as a preset. Lastly, locate the plane exactly where you want it, with the correct speed and trim settings. Then click <code>ESC</code> to pause the game and then <code>SPACE</code> to save the flight as a <code>.FLT</code>. Move the flight file and flightplan to the mission project.

You will need to [[Flight_file_(MSFS)#Creating_your_flight_file|manually edit the .FLT]] to choose the assistance preset, mission category, traffic, briefing and loading screen. You can use the .FLT in the [https://flightsim.to/file/23934/mission-creation-resources SimpleMission project] as a reference.

===== Add pictures =====
Lastly, you will have to add pictures for the mission thumbnail, and the loading, briefing, and ending screens. The names for the loading an briefing pictures are defined in the [[Flight_file_(MSFS)#Creating_your_flight_file|.FLT file]]. The thumbnail will need to be named: <code>Activity_Widget.jpg</code> and the endscreen picture will need to be named: <code>rewardscreen.jpg</code>. You can use the pictures in the [https://flightsim.to/file/23934/mission-creation-resources SimpleMission project] as a reference.

==== [[Weather definitions (MSFS)|Define custom weather]] ====
You can customize the weather with the weather panel during flight. Save it as a new preset. You can find the .WPR file in <code>\AppData\Roaming\Microsoft Flight Simulator\Weather\Presets\</code>. Move it next to the .flt file and rename it to <code>Weather.WPR</code>. You can fine-tune the weather by editing the .WPR file in Notepad++. You can use the .WPR in the [https://flightsim.to/file/23934/mission-creation-resources SimpleMission project] as a reference.

=== Set up a [[:Category:MSFS Mission Script|mission script]] ===
You can set up a [[Category:MSFS_Mission_Script|mission script]] with the SimpleMission sample project. The project contains an .xml you can use as a starting point. [https://flightsim.to/file/23934/mission-creation-resources Download it] and complete [[SimpleMission_(MSFS)#Step_3:_Open_the_project_folder|step 3 of the guide]].

== Coding your mission ==
Now you will turn your mission diagram from [[#Turn_your_story_into_a_mission|Chapter 2.2]] into a mission script. For this you can use the script editor.

=== Script editor ===
With the project open, select your mission asset group and click load in editor:

[[File:OpenScriptEditor.png|500px|thumb|left|How to open the script editor]]<br clear=all>

With the built-in script editor you can create the mission with a visual representation of the script. All building blocks of the mission – such as triggers and actions – are represented by nodes (also called '''''mission objects'''''). Each node contains some settings specific to the building block and can be connected to other nodes.

[[File:BasicMissionNodes.png|700px|thumb|left|Some of the nodes of a basic mission]]<br clear=all>

Nodes have two types of connections. Connections on the right size are references to other nodes and connections on the left size means the node is referenced by other nodes.

You can use special comment nodes to clarify the working of complex missions:

[[File:CommentNodes.png|500px|thumb|left|Comment nodes used to show the working of a block of nodes]]<br clear=all>

=== [[:Category:MSFS_Mission_Script#Building_blocks|Script Building Blocks]] ===
There are different [[Category:MSFS_Mission_Script#Building_blocks|types of nodes]] that you can use to make your mission.

==== [[MSFS Mission Script - Triggers|Triggers]] & [[MSFS Mission Script - Actions|Actions]] ====
The basic parts of a mission script are triggers and actions. When a trigger ‘fires’, it can start different actions and activate other triggers. A bunch of these together makes up a basic mission.

==== [[MSFS Mission Script - Mission objects|Mission objects]] ====
Mission objecs define a range of things like mission type, goals, world traffic, camera, and thermals.

==== [[MSFS Mission Script - Calculator|Calculators]] ====
You can use calculators for more advanced logic in your mission. It can take in multiple variables and trigger different actions based on a logic. You can also use this to calculate a mission score and probably many more applications which you can explore.

{{blockquote|1='''[[:Category:MSFS_Mission_Script#Building_blocks|Look here for a complete overview of objects.]]'''}}

=== Creating your mission script ===
You need to turn your mission diagram into a mission script with the script editor. For everything that happens in your mission, you need to choose and add the correct triggers and link them to actions. For each trigger you have to think: maybe you want something to happen after 10 seconds, or when the plane is at a particular location? There are many triggers too choose from, so you will need to familiarize yourself with [[MSFS_Mission_Script_-_Triggers|all the triggers available to you]], so you can choose the one you need.

==== Placing objects in the world ====
Before you can place objects in the world you have to start a flight and load the mission. The process for loading the mission is described in [[#Testing_the_mission|Chapter 4]].

==== The main mission object ====
You use the mission object to add objectives and an ending to your mission. You can [[MSFS_Mission_Script_-_Mission_objects#List_of_Mission_Types|choose from different types]], according to the type of mission you're creating.

===== Objectives and goal nodes =====
You can add objectives to your mission that determine the mission ending. Each objective has a state that can determine the mission ending. If any objective is set to ''Failed'' or ''Aborted'', the mission ends with pupup and a short message. If all objectives are set to ''Completed'', the mission ends with a debriefing / rewardscreen.

Objectives can be ''Optional'', which means they don't lead to a mission ending at failure and aren't needed to complete the mission, but they still shop up in the ''objectives panel''.

To set and change the states of objectives, you have to link each objective with a [[MSFS_Mission_Script_-_Mission_objects#Goals|Goal or SubGoal node]]. This node has the same states as objectives. You can set the starting state in the node. You have to use a [[(Sub)Goal_Resolution_Action|(Sub)GoalResolutionAction]] to change the state throughout the mission.

'''Steps'''
Objectives can have steps that show up in the objectives panel:

[[File:ObjectivesPanel.jpg|500px|thumb|left|View of objectives and steps in the objectives panel]]<br clear=all>

==== Managing triggers ====
To prevent triggers from firing at unintended moments, you need to make sure triggers are only active when they are needed. Most triggers should start out deactivated and be activated with an [[Object_Activation_Action|ObjectActivationAction]] when the previous trigger in the mission's flow has fired.

[[File:MissionFlowchartTrigger.png|600px|thumb|left|A trigger to warn the player of a low altitude has to be active at the appropriate time]]<br clear=all>

Triggers have a property called ''OneShot''. If it is enabled, the trigger will deactivate itself after it has fired. But some triggers won't fire in every playthrough, such as the llow altitude warning of the example above. If you aren't sure the trigger will deactivate itself, you should deactivate it manually with an ''ObjectActivationAction'' when the trigger isn't needed anymore.

==== Unconnected nodes ====
You can use the script editor to look for breaks in your mission logic. All nodes that aren't referenced by another node are marked with a white dot:

[[File:Script editor example.jpg|300px|thumb|left|Script object overview]]<br clear=all>

This may be a sign of trouble. For actions this means they aren't executed. For triggers this means they will either be active from the beginning or they will always be disabled. For some nodes such as the main [[MSFS_Mission_Script_-_Mission_objects#Defining_the_mission_type|mission object]] this isn't an issue.

=== Testing the mission ===

To quickly test your mission, you can load a flight and then load your mission from a project, as described in [[#Quickly_load_flight_and_mission|Paragraph 4.1]]. However, this won't work for all triggers (such as the intro TimerTrigger). To test your mission more reliably, you first have to build your project and then load the mission flight, as described in [[#Build_project_and_load_the_mission|Paragraph 4.2]].

==== Quickly load flight and mission ====
You can quickly start a flight without building your project:

#Start a flight in the right area or load your mission .FLT.
#Load the mission in the script editor.
#In the script editor, click <code>Game > Update</code>.

==== Build project and load the mission ====
To test your mission more reliably, you first have to build your project and then load the mission flight:

#Build the project.
#Go to custom activities and select your mission.

==== How to edit the mission while it's loaded in ====
When the mission is loaded in, make sure <code>Options > World Objects</code> is enabled.

Now you will see your areas overlayed in the world. With the script editor open you can see if the objects are loaded in the mission. If the names are white, they are loaded, but if they are red it means they are not loaded. While working on your mission, you can update the objects by clicking <code>Script Editor > Game > Update</code>.

[[File:ScriptEditorOverview.png|400px|thumb|left|Script object overview]]<br clear=all>

To add objects, click the plus in the overview window and select the object you want to add. If the object has a [[World_position_(MSFS)|world position]], it will spawn in the middle of your view. To change the location, you can move the object with the Gizmo. For gizmo options, in the script editor click <code>View > Gizmo</code>.

With the Developer Camera enabled you can double click on the objects in the script editor and the camera will go to their location.

[[File:MissionGizmo.jpg|700px|thumb|left|Area with gizmo and gizmo options]]<br clear=all>

=== Debugging mission ===
You can't really use the script editor to view the state of the mission during testing, so your options for debugging are limited. You can debug [[MSFS_Mission_Script_-_Calculator|calculators]] by enabling *DisplayAllowed* and using <code>Options > Flight Object Debug</code>.

=== Exporting the mission ===
To compile the mission for export, click <code>Clean All</code>, then <code>Build All</code>, Make sure there are no errors in the console from the building process. Then click <code>Build & Export</code>, ensure the mission package is checkmarked, choose <code>Community Publishing</code>, and select the Export Directory.

{{Template:Navbox-Mission-Creation-MSFS}}

File:MissionGizmo.jpg

2022-03-03T11:14:26Z

Mr LiamT:

File:ScriptEditorOverview.png

2022-03-03T11:13:43Z

Mr LiamT:

File:MissionFlowchartTrigger.png

2022-03-03T11:11:58Z

Mr LiamT:

File:ObjectivesPanel.jpg

2022-03-03T11:10:59Z

Mr LiamT:

File:CommentNodes.png

2022-03-03T11:10:17Z

Mr LiamT:

File:BasicMissionNodes.png

2022-03-03T11:09:53Z

Mr LiamT:

File:OpenScriptEditor.png

2022-03-03T11:08:07Z

Mr LiamT:

Creating Races for MSFS

2022-01-15T12:38:43Z

Mr LiamT: Created page on creating races for MSFS

MSFS Mission Script - Mission objects

2022-01-15T12:18:06Z

Mr LiamT: /* List of Mission Types */ Add new mission types

MSFS Mission Script - Flow states

2022-01-09T19:41:53Z

Mr LiamT: Add flowstates and panel flowevents

SimpleMission (MSFS)

2022-01-08T23:28:12Z

Mr LiamT: Updated section on RTC's

MSFS Mission Script - Flow states

2022-01-08T22:33:03Z

Mr LiamT: /* List of FlowEvents */

MSFS Mission Script - Flow states

2022-01-08T22:32:24Z

Mr LiamT: /* List of FlowEvents */ Add events and order into categories

MSFS Mission Script - Flow states

2022-01-04T15:48:41Z

Mr LiamT: /* List of FlowEvents */ Add flow events

Template:Infobox-MSFS-Script-Element

2022-01-04T15:23:32Z

Mr LiamT: Changed colors for readability of links

<div align="left" style="width: 40em; border:

{{#switch: {{lc:{{{category|}}} }}
|edition = #efe9b7
|actions = #973919
|areas = #12693f
|missions = #e8c00d
|simobjects = #e8c00d
|triggers = #1e49bf
|rtc = #808080
|flightplan = #808080
|libraryobjects = #7d0bde
|others = #db0b79
|Lightgrey
}}
solid 4px; border-radius: 10px; margin:1em; background-color:#eaecf0; font-family: monospace;">

<div style="font-size: 120%; font-weight: bold; text-align: center; background-color:#d8dade; border-radius: 6px 6px 0 0; padding: 0.2em 0.5em;">{{{title|{{{name|{{PAGENAME}}}}}}}}
</div>

<div style="padding: 0.3em 1em;">
{{{short-descr|}}}
<hr>
{| cellspacing="10em" style="width: 100%;"
|-
! style="width: 30%"|
|
|-
<noinclude>
|}
</div></div>
</noinclude>

MSFS Mission Script - Triggers

2022-01-04T13:34:27Z

Mr LiamT: /* InputActionTrigger */ Add explanation

MSFS Mission Script - Actions

2022-01-04T13:32:20Z

Mr LiamT: /* ChangeNodeAction */ Add explanation

[[Category:MSFS_Mission_Script]]

{{:Ambox-Content-WIP}}

{{Infobox-Applicable-FSVersion
| MSFS = true
| FSXI = false
| P3D5 = false
| P3D4 = false
| P3D3 = false
| P3D2 = false
| P3D = false
| FSW = false
| FSXSE = false
| FSXA = false
| FSX = false
| FS2004 = false
| FS2002 = false
| XP11 = false
| XP10 = false
| XP9 = false
}}

{{:Transclusion_MSFS_Mission_Script}}

== Action queue ==
All actions are fired in the order they’re listed in the ObjectReferenceList of the trigger that fired. This is important, because Dialog actions take time to play and will delay any actions that follow them. If a delay is set on a Dialog action, then the next action in the queue will be delayed by that amount. You can arrange the order in which actions in a given queue fire by changing the order manually in the .xml.

== Common actions ==
[[Object Activation Action|ObjectActivationAction]], [[Dialog Action|DialogAction]], [[Change Assistance Item Action|ChangeAssistanceItemAction]], [[Failure Action|FailureAction]], [[Adjust Payload Action|AdjustPayloadAction]], [[Refill Action|RefillAction]], [[MSFS_Mission_Script_-_Flow_states#FlowStateAction|FlowStateAction]].

== General attributes ==
Actions have a few general attributes:
=== Immediate ===
'''False:''' This action will wait for prior action in the action queue to complete. The order is determined by the order the actions are listed in the trigger. This can be changed by manually editing the order in the '''Actions''' section of the element in the mission .xml.<br>
'''True:''' This action will ignore the action queue and start immediately.

=== BreakOnExecute ===
Official description: "Code break if action is executed". Not sure what that means
=== TargetPlayer ===
The target player refers to the target of an action in a multiplayer mission. Action Target can be the GUID of a particular player or team, or you can use one of the specially defined guids to refer to relative targets:
{| class="wikitable"
|Local User
|{8B7615FA-BBBF-4baa-B959-5EF4F59BB575}
|-
|All Players
|{D09ADD85-4CA8-4be9-939C-4544BA259DA2}
|-
|Trigger
|{9A82F89B-F271-4285-AE90-1F733945D975}
|-
|All Players Except Trigger
|{D2764AC8-FBB3-4b9b-9721-3C3EA0CB402B}
|}

== Mission logic ==
==== [[Object Activation Action|ObjectActivationAction]] ====
Very useful action to (de)activate objects such as triggers and InGameMarkers.
==== [[Random_Action|RandomAction]] ====
Randomly executes one action from a list. First, the action has a probability that any action is executed at all. If it does execute, it randomly chooses one action that will execute.

==== ExecuteRPNAction ====
Execute RPN code.
==== SkipAction ====
Skip an action.
==== StopObjectActionQueueAction ====
Stop action queues of referenced objects
==== ExecuteListAction ====
Execute a list of action
==== WaitAction ====
Action that does nothing... for a predefined time. You can use this to delay the next items in an actionQeue.

== Actions related to a trigger ==
==== [[Count Action|CountAction]] ====
Changes the count of a [[Counter_Trigger|CounterTrigger]]
==== [[Reset Timer Action|ResetTimerAction]] ====
Reset the timer to the StartTime.
==== [[Timer Adjust Action|TimerAdjustAction]] ====
Adjusts the time of a [[Timer Trigger|TimerTrigger]] up or down.

== Action related to [[MSFS Mission Script - Mission objects|Mission objects]] ==
==== [[(Sub)Goal_Resolution_Action|GoalResolutionAction & SubGoalResolutionAction]] ====
Changes the state of a [[MSFS_Mission_Script_-_Mission_objects#Goals|(sub)goal]].
==== [[Grant Reward Action|GrantRewardAction]] ====
Untested.
==== [[Point Of Interest Activation Action|PointOfInterestActivationAction]] ====
(De)activates a [[point of interest]]
==== POIChangeModelAction ====
Unknown.

== Sound ==
==== [[Dialog Action|DialogAction]] ====
Plays dialog for the copilot and atc. It can use sound files or text-to-speech (TTS). The dialogAction can also show subtitles.
==== InstructorDialogAction ====
Same as a DialogAction, but allows for a male and female voice, depending on the player's selected instructor in the settings.
==== OneShotSoundAction ====
Plays specified sound file. Doesn't seem to work in MSFS.
==== PlayListAction ====
Plays through a list of sound files. Doesn't seem to work in MSFS.
==== PlaySoundAction ====
Play a sound in 3D space. Uses a WWise event.
==== StopSoundAction ====
Stop a sound.
==== SoundEffectAction ====
Sets sound effects. Doesn't seem to work in MSFS.
==== RTPCAction ====
Send a WWise RTPC.

== Player/Aircraft ==
==== [[Change Assistance Item Action|ChangeAssistanceItemAction]] ====
Changes specific assistance items throughout the mission.
==== [[Failure Action|FailureAction]] ====
Fail a system (e.g., fuel pump, gear, altimeter, radios).
==== [[Adjust Payload Action|AdjustPayloadAction]] ====
Set or adjust the weight on a payload station (weight of pilot, passengers, baggage, etc).
==== [[Refill Action|RefillAction]] ====
Add or subtract percent of a substance (e.g., fuel).
==== ChangeObjectTypeAction ====
Change an object to a different type.
==== [[Request Teleport Action|RequestTeleportAction]] ====
Request a teleport.
==== RequestTeleportCameraAction ====
Teleport current camera to a position given in a CFG file (e.g, close instrument view, wide cockpit view, gear view).
==== SkipTimeAction ====
Very cool action allowing you to speed up or skip time without affecting the simulation. It will speed up cloud movement and the day-night cycle, but keep the planes, other vehicles, and animations at the normal speed.

== Action related to AI / Simobjects ==
==== [[AI Take Controls Action|AITakeControlsAction]] ====
Changes control of the users' plane between user and AI.
==== [[Send Message To AI Action|SendMessageToAIAction]] ====
Currently useless for missions. See [https://docs.flightsimulator.com/html/Content_Configuration/Environment/Living_World/Airport_Services/Service_And_IdleWorker_Script_Definitions.htm?rhhlterm=sendmessagetoaiaction#h2 documentation].
==== [[Activate Waypoints Action|ActivateWaypointsAction]] ====
Send waypoints to a [[Simobject]] for the AI to follow.
==== WaypointsFromAnotherWaypointAction ====
Get waypoint list for another ActivateWaypointsAction.
==== PlayFlightRecordingAction ====
Plays back recording for the [[MSFS_Mission_Script_-_Sim_Objects#AirplanePlaybackAI|AirplanePlaybackAI]].

==== SpawnAction ====

== [[MSFS_Mission_Script_-_Flow_states|Flowstate]] ==
==== FlowEventAction ====
==== FlowStateAction ====
==== TimerTriggerFlowStateAction ====
==== TransitionAction ====
==== ToggleVisibilityAction ====

== [[MSFS_Mission_Script_-_Events|Event]] ==
==== EventTriggerActivationAction ====
==== EventTriggerAction ====
==== EventAction ====

== Animation / effects / RTC ==
==== [[Fade To Color Action|FadeToColorAction]] ====
Fades a color over the whole viewport. Useful for teleports and testing.
==== AttachEffectAction ====
Attach a visual effect to an object (e.g., plane, simobject).
==== PlayAnimationAction ====
Play an animation.
==== PlayBlendTreeStateAction ====
Play a blend tree state.
==== RTCLocationsPreloadAction ====

== Replay ==
==== RecordReplayAction ====
Record a new replay and store in file.
==== PlayReplayAction ====
Play a replay file.
==== PlayGhostAction ====
Play a ghost replay.

== Race ==
==== DisqualifyPlayerAction ====
Disqualify a player.
==== RaceCourseActivateAction ====
Enable race course progress for all players.
==== RaceClockStartAction ====
Start the global race timer for all players.
==== TimePenaltyAction ====
Give a player a time penalty/bonus.
==== BackOnTrackAction ====
When a crash occurs in a race course, the crash is 'not allowed' and the player is teleported to the pylon before his crash.

== Other ==
==== FocusInstrumentAction ====
Focus the camera on a specific instrument. You can highlight the instrument as well (blue glow).

==== RumbleAction ====
Controller rumble effect.
==== CustomAction ====
Create a custom action that uses an external program connected with simconnect.
==== ChangeMarkerTemplateAction ====
Change marker template.
==== ChangeRopeLinkAction ====
Change link on ropes.
==== ChangeNodeAction ====
Change node property (e.g. hide the yoke).

==== AttachDroppablePayloadAction ====
Attach a droppable payload.
==== AgentMessageAction ====
Send or reveive a message from an agent (ATC?).
==== MissionScoreToLeaderboardAction ====
Try to send mission score to leaderboard. Not (yet) supported for unofficial missions.
==== ShowLogbookAction ====
Show the logbook.
==== FilterInputKeyAction ====
Change input key processing (e.g. turn of the input key for the elevator).

{{Template:Navbox-Mission-Creation-MSFS}}

MSFS Mission Script - Actions

2022-01-04T13:31:03Z

Mr LiamT: /* FilterInputKeyAction */ Add explanation

[[Category:MSFS_Mission_Script]]

{{:Ambox-Content-WIP}}

{{Infobox-Applicable-FSVersion
| MSFS = true
| FSXI = false
| P3D5 = false
| P3D4 = false
| P3D3 = false
| P3D2 = false
| P3D = false
| FSW = false
| FSXSE = false
| FSXA = false
| FSX = false
| FS2004 = false
| FS2002 = false
| XP11 = false
| XP10 = false
| XP9 = false
}}

{{:Transclusion_MSFS_Mission_Script}}

== Action queue ==
All actions are fired in the order they’re listed in the ObjectReferenceList of the trigger that fired. This is important, because Dialog actions take time to play and will delay any actions that follow them. If a delay is set on a Dialog action, then the next action in the queue will be delayed by that amount. You can arrange the order in which actions in a given queue fire by changing the order manually in the .xml.

== Common actions ==
[[Object Activation Action|ObjectActivationAction]], [[Dialog Action|DialogAction]], [[Change Assistance Item Action|ChangeAssistanceItemAction]], [[Failure Action|FailureAction]], [[Adjust Payload Action|AdjustPayloadAction]], [[Refill Action|RefillAction]], [[MSFS_Mission_Script_-_Flow_states#FlowStateAction|FlowStateAction]].

== General attributes ==
Actions have a few general attributes:
=== Immediate ===
'''False:''' This action will wait for prior action in the action queue to complete. The order is determined by the order the actions are listed in the trigger. This can be changed by manually editing the order in the '''Actions''' section of the element in the mission .xml.<br>
'''True:''' This action will ignore the action queue and start immediately.

=== BreakOnExecute ===
Official description: "Code break if action is executed". Not sure what that means
=== TargetPlayer ===
The target player refers to the target of an action in a multiplayer mission. Action Target can be the GUID of a particular player or team, or you can use one of the specially defined guids to refer to relative targets:
{| class="wikitable"
|Local User
|{8B7615FA-BBBF-4baa-B959-5EF4F59BB575}
|-
|All Players
|{D09ADD85-4CA8-4be9-939C-4544BA259DA2}
|-
|Trigger
|{9A82F89B-F271-4285-AE90-1F733945D975}
|-
|All Players Except Trigger
|{D2764AC8-FBB3-4b9b-9721-3C3EA0CB402B}
|}

== Mission logic ==
==== [[Object Activation Action|ObjectActivationAction]] ====
Very useful action to (de)activate objects such as triggers and InGameMarkers.
==== [[Random_Action|RandomAction]] ====
Randomly executes one action from a list. First, the action has a probability that any action is executed at all. If it does execute, it randomly chooses one action that will execute.

==== ExecuteRPNAction ====
Execute RPN code.
==== SkipAction ====
Skip an action.
==== StopObjectActionQueueAction ====
Stop action queues of referenced objects
==== ExecuteListAction ====
Execute a list of action
==== WaitAction ====
Action that does nothing... for a predefined time. You can use this to delay the next items in an actionQeue.

== Actions related to a trigger ==
==== [[Count Action|CountAction]] ====
Changes the count of a [[Counter_Trigger|CounterTrigger]]
==== [[Reset Timer Action|ResetTimerAction]] ====
Reset the timer to the StartTime.
==== [[Timer Adjust Action|TimerAdjustAction]] ====
Adjusts the time of a [[Timer Trigger|TimerTrigger]] up or down.

== Action related to [[MSFS Mission Script - Mission objects|Mission objects]] ==
==== [[(Sub)Goal_Resolution_Action|GoalResolutionAction & SubGoalResolutionAction]] ====
Changes the state of a [[MSFS_Mission_Script_-_Mission_objects#Goals|(sub)goal]].
==== [[Grant Reward Action|GrantRewardAction]] ====
Untested.
==== [[Point Of Interest Activation Action|PointOfInterestActivationAction]] ====
(De)activates a [[point of interest]]
==== POIChangeModelAction ====
Unknown.

== Sound ==
==== [[Dialog Action|DialogAction]] ====
Plays dialog for the copilot and atc. It can use sound files or text-to-speech (TTS). The dialogAction can also show subtitles.
==== InstructorDialogAction ====
Same as a DialogAction, but allows for a male and female voice, depending on the player's selected instructor in the settings.
==== OneShotSoundAction ====
Plays specified sound file. Doesn't seem to work in MSFS.
==== PlayListAction ====
Plays through a list of sound files. Doesn't seem to work in MSFS.
==== PlaySoundAction ====
Play a sound in 3D space. Uses a WWise event.
==== StopSoundAction ====
Stop a sound.
==== SoundEffectAction ====
Sets sound effects. Doesn't seem to work in MSFS.
==== RTPCAction ====
Send a WWise RTPC.

== Player/Aircraft ==
==== [[Change Assistance Item Action|ChangeAssistanceItemAction]] ====
Changes specific assistance items throughout the mission.
==== [[Failure Action|FailureAction]] ====
Fail a system (e.g., fuel pump, gear, altimeter, radios).
==== [[Adjust Payload Action|AdjustPayloadAction]] ====
Set or adjust the weight on a payload station (weight of pilot, passengers, baggage, etc).
==== [[Refill Action|RefillAction]] ====
Add or subtract percent of a substance (e.g., fuel).
==== ChangeObjectTypeAction ====
Change an object to a different type.
==== [[Request Teleport Action|RequestTeleportAction]] ====
Request a teleport.
==== RequestTeleportCameraAction ====
Teleport current camera to a position given in a CFG file (e.g, close instrument view, wide cockpit view, gear view).
==== SkipTimeAction ====
Very cool action allowing you to speed up or skip time without affecting the simulation. It will speed up cloud movement and the day-night cycle, but keep the planes, other vehicles, and animations at the normal speed.

== Action related to AI / Simobjects ==
==== [[AI Take Controls Action|AITakeControlsAction]] ====
Changes control of the users' plane between user and AI.
==== [[Send Message To AI Action|SendMessageToAIAction]] ====
Currently useless for missions. See [https://docs.flightsimulator.com/html/Content_Configuration/Environment/Living_World/Airport_Services/Service_And_IdleWorker_Script_Definitions.htm?rhhlterm=sendmessagetoaiaction#h2 documentation].
==== [[Activate Waypoints Action|ActivateWaypointsAction]] ====
Send waypoints to a [[Simobject]] for the AI to follow.
==== WaypointsFromAnotherWaypointAction ====
Get waypoint list for another ActivateWaypointsAction.
==== PlayFlightRecordingAction ====
Plays back recording for the [[MSFS_Mission_Script_-_Sim_Objects#AirplanePlaybackAI|AirplanePlaybackAI]].

==== SpawnAction ====

== [[MSFS_Mission_Script_-_Flow_states|Flowstate]] ==
==== FlowEventAction ====
==== FlowStateAction ====
==== TimerTriggerFlowStateAction ====
==== TransitionAction ====
==== ToggleVisibilityAction ====

== [[MSFS_Mission_Script_-_Events|Event]] ==
==== EventTriggerActivationAction ====
==== EventTriggerAction ====
==== EventAction ====

== Animation / effects / RTC ==
==== [[Fade To Color Action|FadeToColorAction]] ====
Fades a color over the whole viewport. Useful for teleports and testing.
==== AttachEffectAction ====
Attach a visual effect to an object (e.g., plane, simobject).
==== PlayAnimationAction ====
Play an animation.
==== PlayBlendTreeStateAction ====
Play a blend tree state.
==== RTCLocationsPreloadAction ====

== Replay ==
==== RecordReplayAction ====
Record a new replay and store in file.
==== PlayReplayAction ====
Play a replay file.
==== PlayGhostAction ====
Play a ghost replay.

== Race ==
==== DisqualifyPlayerAction ====
Disqualify a player.
==== RaceCourseActivateAction ====
Enable race course progress for all players.
==== RaceClockStartAction ====
Start the global race timer for all players.
==== TimePenaltyAction ====
Give a player a time penalty/bonus.
==== BackOnTrackAction ====
When a crash occurs in a race course, the crash is 'not allowed' and the player is teleported to the pylon before his crash.

== Other ==
==== FocusInstrumentAction ====
Focus the camera on a specific instrument. You can highlight the instrument as well (blue glow).

==== RumbleAction ====
Controller rumble effect.
==== CustomAction ====
Create a custom action that uses an external program connected with simconnect.
==== ChangeMarkerTemplateAction ====
Change marker template.
==== ChangeRopeLinkAction ====
Change link on ropes.
==== ChangeNodeAction ====
Change node property.
==== AttachDroppablePayloadAction ====
Attach a droppable payload.
==== AgentMessageAction ====
Send or reveive a message from an agent (ATC?).
==== MissionScoreToLeaderboardAction ====
Try to send mission score to leaderboard. Not (yet) supported for unofficial missions.
==== ShowLogbookAction ====
Show the logbook.
==== FilterInputKeyAction ====
Change input key processing (e.g. turn of the input key for the elevator).

{{Template:Navbox-Mission-Creation-MSFS}}

MSFS Mission Script - Actions

2022-01-04T13:17:47Z

Mr LiamT: /* Immediate */ Expand explanation

[[Category:MSFS_Mission_Script]]

{{:Ambox-Content-WIP}}

{{Infobox-Applicable-FSVersion
| MSFS = true
| FSXI = false
| P3D5 = false
| P3D4 = false
| P3D3 = false
| P3D2 = false
| P3D = false
| FSW = false
| FSXSE = false
| FSXA = false
| FSX = false
| FS2004 = false
| FS2002 = false
| XP11 = false
| XP10 = false
| XP9 = false
}}

{{:Transclusion_MSFS_Mission_Script}}

== Action queue ==
All actions are fired in the order they’re listed in the ObjectReferenceList of the trigger that fired. This is important, because Dialog actions take time to play and will delay any actions that follow them. If a delay is set on a Dialog action, then the next action in the queue will be delayed by that amount. You can arrange the order in which actions in a given queue fire by changing the order manually in the .xml.

== Common actions ==
[[Object Activation Action|ObjectActivationAction]], [[Dialog Action|DialogAction]], [[Change Assistance Item Action|ChangeAssistanceItemAction]], [[Failure Action|FailureAction]], [[Adjust Payload Action|AdjustPayloadAction]], [[Refill Action|RefillAction]], [[MSFS_Mission_Script_-_Flow_states#FlowStateAction|FlowStateAction]].

== General attributes ==
Actions have a few general attributes:
=== Immediate ===
'''False:''' This action will wait for prior action in the action queue to complete. The order is determined by the order the actions are listed in the trigger. This can be changed by manually editing the order in the '''Actions''' section of the element in the mission .xml.<br>
'''True:''' This action will ignore the action queue and start immediately.

=== BreakOnExecute ===
Official description: "Code break if action is executed". Not sure what that means
=== TargetPlayer ===
The target player refers to the target of an action in a multiplayer mission. Action Target can be the GUID of a particular player or team, or you can use one of the specially defined guids to refer to relative targets:
{| class="wikitable"
|Local User
|{8B7615FA-BBBF-4baa-B959-5EF4F59BB575}
|-
|All Players
|{D09ADD85-4CA8-4be9-939C-4544BA259DA2}
|-
|Trigger
|{9A82F89B-F271-4285-AE90-1F733945D975}
|-
|All Players Except Trigger
|{D2764AC8-FBB3-4b9b-9721-3C3EA0CB402B}
|}

== Mission logic ==
==== [[Object Activation Action|ObjectActivationAction]] ====
Very useful action to (de)activate objects such as triggers and InGameMarkers.
==== [[Random_Action|RandomAction]] ====
Randomly executes one action from a list. First, the action has a probability that any action is executed at all. If it does execute, it randomly chooses one action that will execute.

==== ExecuteRPNAction ====
Execute RPN code.
==== SkipAction ====
Skip an action.
==== StopObjectActionQueueAction ====
Stop action queues of referenced objects
==== ExecuteListAction ====
Execute a list of action
==== WaitAction ====
Action that does nothing... for a predefined time. You can use this to delay the next items in an actionQeue.

== Actions related to a trigger ==
==== [[Count Action|CountAction]] ====
Changes the count of a [[Counter_Trigger|CounterTrigger]]
==== [[Reset Timer Action|ResetTimerAction]] ====
Reset the timer to the StartTime.
==== [[Timer Adjust Action|TimerAdjustAction]] ====
Adjusts the time of a [[Timer Trigger|TimerTrigger]] up or down.

== Action related to [[MSFS Mission Script - Mission objects|Mission objects]] ==
==== [[(Sub)Goal_Resolution_Action|GoalResolutionAction & SubGoalResolutionAction]] ====
Changes the state of a [[MSFS_Mission_Script_-_Mission_objects#Goals|(sub)goal]].
==== [[Grant Reward Action|GrantRewardAction]] ====
Untested.
==== [[Point Of Interest Activation Action|PointOfInterestActivationAction]] ====
(De)activates a [[point of interest]]
==== POIChangeModelAction ====
Unknown.

== Sound ==
==== [[Dialog Action|DialogAction]] ====
Plays dialog for the copilot and atc. It can use sound files or text-to-speech (TTS). The dialogAction can also show subtitles.
==== InstructorDialogAction ====
Same as a DialogAction, but allows for a male and female voice, depending on the player's selected instructor in the settings.
==== OneShotSoundAction ====
Plays specified sound file. Doesn't seem to work in MSFS.
==== PlayListAction ====
Plays through a list of sound files. Doesn't seem to work in MSFS.
==== PlaySoundAction ====
Play a sound in 3D space. Uses a WWise event.
==== StopSoundAction ====
Stop a sound.
==== SoundEffectAction ====
Sets sound effects. Doesn't seem to work in MSFS.
==== RTPCAction ====
Send a WWise RTPC.

== Player/Aircraft ==
==== [[Change Assistance Item Action|ChangeAssistanceItemAction]] ====
Changes specific assistance items throughout the mission.
==== [[Failure Action|FailureAction]] ====
Fail a system (e.g., fuel pump, gear, altimeter, radios).
==== [[Adjust Payload Action|AdjustPayloadAction]] ====
Set or adjust the weight on a payload station (weight of pilot, passengers, baggage, etc).
==== [[Refill Action|RefillAction]] ====
Add or subtract percent of a substance (e.g., fuel).
==== ChangeObjectTypeAction ====
Change an object to a different type.
==== [[Request Teleport Action|RequestTeleportAction]] ====
Request a teleport.
==== RequestTeleportCameraAction ====
Teleport current camera to a position given in a CFG file (e.g, close instrument view, wide cockpit view, gear view).
==== SkipTimeAction ====
Very cool action allowing you to speed up or skip time without affecting the simulation. It will speed up cloud movement and the day-night cycle, but keep the planes, other vehicles, and animations at the normal speed.

== Action related to AI / Simobjects ==
==== [[AI Take Controls Action|AITakeControlsAction]] ====
Changes control of the users' plane between user and AI.
==== [[Send Message To AI Action|SendMessageToAIAction]] ====
Currently useless for missions. See [https://docs.flightsimulator.com/html/Content_Configuration/Environment/Living_World/Airport_Services/Service_And_IdleWorker_Script_Definitions.htm?rhhlterm=sendmessagetoaiaction#h2 documentation].
==== [[Activate Waypoints Action|ActivateWaypointsAction]] ====
Send waypoints to a [[Simobject]] for the AI to follow.
==== WaypointsFromAnotherWaypointAction ====
Get waypoint list for another ActivateWaypointsAction.
==== PlayFlightRecordingAction ====
Plays back recording for the [[MSFS_Mission_Script_-_Sim_Objects#AirplanePlaybackAI|AirplanePlaybackAI]].

==== SpawnAction ====

== [[MSFS_Mission_Script_-_Flow_states|Flowstate]] ==
==== FlowEventAction ====
==== FlowStateAction ====
==== TimerTriggerFlowStateAction ====
==== TransitionAction ====
==== ToggleVisibilityAction ====

== [[MSFS_Mission_Script_-_Events|Event]] ==
==== EventTriggerActivationAction ====
==== EventTriggerAction ====
==== EventAction ====

== Animation / effects / RTC ==
==== [[Fade To Color Action|FadeToColorAction]] ====
Fades a color over the whole viewport. Useful for teleports and testing.
==== AttachEffectAction ====
Attach a visual effect to an object (e.g., plane, simobject).
==== PlayAnimationAction ====
Play an animation.
==== PlayBlendTreeStateAction ====
Play a blend tree state.
==== RTCLocationsPreloadAction ====

== Replay ==
==== RecordReplayAction ====
Record a new replay and store in file.
==== PlayReplayAction ====
Play a replay file.
==== PlayGhostAction ====
Play a ghost replay.

== Race ==
==== DisqualifyPlayerAction ====
Disqualify a player.
==== RaceCourseActivateAction ====
Enable race course progress for all players.
==== RaceClockStartAction ====
Start the global race timer for all players.
==== TimePenaltyAction ====
Give a player a time penalty/bonus.
==== BackOnTrackAction ====
When a crash occurs in a race course, the crash is 'not allowed' and the player is teleported to the pylon before his crash.

== Other ==
==== FocusInstrumentAction ====
Focus the camera on a specific instrument. You can highlight the instrument as well (blue glow).

==== RumbleAction ====
Controller rumble effect.
==== CustomAction ====
Create a custom action that uses an external program connected with simconnect.
==== ChangeMarkerTemplateAction ====
Change marker template.
==== ChangeRopeLinkAction ====
Change link on ropes.
==== ChangeNodeAction ====
Change node property.
==== AttachDroppablePayloadAction ====
Attach a droppable payload.
==== AgentMessageAction ====
Send or reveive a message from an agent (ATC?).
==== MissionScoreToLeaderboardAction ====
Try to send mission score to leaderboard. Not (yet) supported for unofficial missions.
==== ShowLogbookAction ====
Show the logbook.
==== FilterInputKeyAction ====
Change input key processing.

{{Template:Navbox-Mission-Creation-MSFS}}

Category:MSFS Mission Script

2022-01-04T13:06:29Z

Mr LiamT: /* General Element Attributes */ Add explanation for VRDependency

Dialog Action

2022-01-03T20:20:08Z

Mr LiamT: Fixed DelaySeconds Explanation

[[Category:MSFS Mission Script]]
{{:Ambox-Content-WIP}}
{{Infobox-Applicable-FSVersion
| MSFS = true
| FSXI = false
| P3D5 = false
| P3D4 = false
| P3D3 = false
| P3D2 = false
| P3D = false
| FSW = false
| FSXSE = false
| FSXA = false
| FSX = false
| FS2004 = false
| FS2002 = false
| XP11 = false
| XP10 = false
| XP9 = false
}}
This plays dialog for the copilot and atc. It can use sound files or text-to-speech (TTS). The dialogAction can also show subtitles.

{{Infobox-MSFS-Script-Element
| category = Actions
| name = DialogAction
| short-descr = Fires when a counter reaches a specified target.
}}
!Text
|'''Mandatory''' text for the subtitles and Text-To-Speech. Can be [[Localisation (MSFS)|localized]].
|-
!SoundFileName
|File name of the sound to be played. Put your sound files in the '''[[Mission_structure_(MSFS)|Sound folder]]'''.
|-
!PackageName
|
|-
!DelaySeconds
|Time to wait before playing this dialog. Useful for pacing your dialog.
|-
!Skippable
|
|-
!Speaker
|Each speaker has a separate channel which can only play one file at a time. Possible values are:<br>NARRATOR, INSTRUCTOR, COPILOT.
|-
!Priority
|
|-
!CanBeSuspended
|
|-
!EndActions
|You can link actions to play after the dialog has finished.
|-
!EndActions DelaySeconds
|How long to wait before activating the EndActions.
{{Infobox-MSFS-Script-Element-End}}

Adding dialog to your mission gives it a new level and enables you to better tell stories and make a cool experience. You can use the build in Text-To-Speech or your own audio recordings.

== Possible uses ==
* ATC chatter
* Let the copilot give feedback on the landing

== Related elements and alternatives ==
* For non-dialog sounds use a [[One_Shot_Sound_Action|OneShotSoundAction]], [[Play_Sound_Action|PlaySoundAction]], or [[Sound_Effect_Action|SoundEffectAction]].
* For music use a [[Play_List_Action|PlayListAction]]

{{Template:Navbox-Mission-Creation-MSFS}}

MSFS Mission Script - Calculator

2021-12-14T21:52:37Z

Mr LiamT: Add headings for two calculator objects

MSFS Mission Script - Actions

2021-12-12T20:25:30Z

Mr LiamT: /* SkipTimeAction */ Add description

[[Category:MSFS_Mission_Script]]

{{:Ambox-Content-WIP}}

{{Infobox-Applicable-FSVersion
| MSFS = true
| FSXI = false
| P3D5 = false
| P3D4 = false
| P3D3 = false
| P3D2 = false
| P3D = false
| FSW = false
| FSXSE = false
| FSXA = false
| FSX = false
| FS2004 = false
| FS2002 = false
| XP11 = false
| XP10 = false
| XP9 = false
}}

{{:Transclusion_MSFS_Mission_Script}}

== Action queue ==
All actions are fired in the order they’re listed in the ObjectReferenceList of the trigger that fired. This is important, because Dialog actions take time to play and will delay any actions that follow them. If a delay is set on a Dialog action, then the next action in the queue will be delayed by that amount. You can arrange the order in which actions in a given queue fire by changing the order manually in the .xml.

== Common actions ==
[[Object Activation Action|ObjectActivationAction]], [[Dialog Action|DialogAction]], [[Change Assistance Item Action|ChangeAssistanceItemAction]], [[Failure Action|FailureAction]], [[Adjust Payload Action|AdjustPayloadAction]], [[Refill Action|RefillAction]], [[MSFS_Mission_Script_-_Flow_states#FlowStateAction|FlowStateAction]].

== General attributes ==
Actions have a few general attributes:
=== Immediate ===
'''True:''' This action will start immediately<br>
'''False:''' This action will wait for other actions to complete. The order is determined by the order the actions are listed in the trigger. This can be changed by manually editing the order in the '''ObjectReference''' section of the element in the mission .xml.
=== BreakOnExecute ===
Official description: "Code break if action is executed". Not sure what that means
=== TargetPlayer ===
The target player refers to the target of an action in a multiplayer mission. Action Target can be the GUID of a particular player or team, or you can use one of the specially defined guids to refer to relative targets:
{| class="wikitable"
|Local User
|{8B7615FA-BBBF-4baa-B959-5EF4F59BB575}
|-
|All Players
|{D09ADD85-4CA8-4be9-939C-4544BA259DA2}
|-
|Trigger
|{9A82F89B-F271-4285-AE90-1F733945D975}
|-
|All Players Except Trigger
|{D2764AC8-FBB3-4b9b-9721-3C3EA0CB402B}
|}

== Mission logic ==
==== [[Object Activation Action|ObjectActivationAction]] ====
Very useful action to (de)activate objects such as triggers and InGameMarkers.
==== [[Random_Action|RandomAction]] ====
Randomly executes one action from a list. First, the action has a probability that any action is executed at all. If it does execute, it randomly chooses one action that will execute.

==== ExecuteRPNAction ====
Execute RPN code.
==== SkipAction ====
Skip an action.
==== StopObjectActionQueueAction ====
Stop action queues of referenced objects
==== ExecuteListAction ====
Execute a list of action
==== WaitAction ====
Action that does nothing... for a predefined time. You can use this to delay the next items in an actionQeue.

== Actions related to a trigger ==
==== [[Count Action|CountAction]] ====
Changes the count of a [[Counter_Trigger|CounterTrigger]]
==== [[Reset Timer Action|ResetTimerAction]] ====
Reset the timer to the StartTime.
==== [[Timer Adjust Action|TimerAdjustAction]] ====
Adjusts the time of a [[Timer Trigger|TimerTrigger]] up or down.

== Action related to [[MSFS Mission Script - Mission objects|Mission objects]] ==
==== [[(Sub)Goal_Resolution_Action|GoalResolutionAction & SubGoalResolutionAction]] ====
Changes the state of a [[MSFS_Mission_Script_-_Mission_objects#Goals|(sub)goal]].
==== [[Grant Reward Action|GrantRewardAction]] ====
Untested.
==== [[Point Of Interest Activation Action|PointOfInterestActivationAction]] ====
(De)activates a [[point of interest]]
==== POIChangeModelAction ====
Unknown.

== Sound ==
==== [[Dialog Action|DialogAction]] ====
Plays dialog for the copilot and atc. It can use sound files or text-to-speech (TTS). The dialogAction can also show subtitles.
==== InstructorDialogAction ====
Same as a DialogAction, but allows for a male and female voice, depending on the player's selected instructor in the settings.
==== OneShotSoundAction ====
Plays specified sound file. Doesn't seem to work in MSFS.
==== PlayListAction ====
Plays through a list of sound files. Doesn't seem to work in MSFS.
==== PlaySoundAction ====
Play a sound in 3D space. Uses a WWise event.
==== StopSoundAction ====
Stop a sound.
==== SoundEffectAction ====
Sets sound effects. Doesn't seem to work in MSFS.
==== RTPCAction ====
Send a WWise RTPC.

== Player/Aircraft ==
==== [[Change Assistance Item Action|ChangeAssistanceItemAction]] ====
Changes specific assistance items throughout the mission.
==== [[Failure Action|FailureAction]] ====
Fail a system (e.g., fuel pump, gear, altimeter, radios).
==== [[Adjust Payload Action|AdjustPayloadAction]] ====
Set or adjust the weight on a payload station (weight of pilot, passengers, baggage, etc).
==== [[Refill Action|RefillAction]] ====
Add or subtract percent of a substance (e.g., fuel).
==== ChangeObjectTypeAction ====
Change an object to a different type.
==== [[Request Teleport Action|RequestTeleportAction]] ====
Request a teleport.
==== RequestTeleportCameraAction ====
Teleport current camera to a position given in a CFG file (e.g, close instrument view, wide cockpit view, gear view).
==== SkipTimeAction ====
Very cool action allowing you to speed up or skip time without affecting the simulation. It will speed up cloud movement and the day-night cycle, but keep the planes, other vehicles, and animations at the normal speed.

== Action related to AI / Simobjects ==
==== [[AI Take Controls Action|AITakeControlsAction]] ====
Changes control of the users' plane between user and AI.
==== [[Send Message To AI Action|SendMessageToAIAction]] ====
Currently useless for missions. See [https://docs.flightsimulator.com/html/Content_Configuration/Environment/Living_World/Airport_Services/Service_And_IdleWorker_Script_Definitions.htm?rhhlterm=sendmessagetoaiaction#h2 documentation].
==== [[Activate Waypoints Action|ActivateWaypointsAction]] ====
Send waypoints to a [[Simobject]] for the AI to follow.
==== WaypointsFromAnotherWaypointAction ====
Get waypoint list for another ActivateWaypointsAction.
==== PlayFlightRecordingAction ====
Plays back recording for the [[MSFS_Mission_Script_-_Sim_Objects#AirplanePlaybackAI|AirplanePlaybackAI]].

==== SpawnAction ====

== [[MSFS_Mission_Script_-_Flow_states|Flowstate]] ==
==== FlowEventAction ====
==== FlowStateAction ====
==== TimerTriggerFlowStateAction ====
==== TransitionAction ====
==== ToggleVisibilityAction ====

== [[MSFS_Mission_Script_-_Events|Event]] ==
==== EventTriggerActivationAction ====
==== EventTriggerAction ====
==== EventAction ====

== Animation / effects / RTC ==
==== [[Fade To Color Action|FadeToColorAction]] ====
Fades a color over the whole viewport. Useful for teleports and testing.
==== AttachEffectAction ====
Attach a visual effect to an object (e.g., plane, simobject).
==== PlayAnimationAction ====
Play an animation.
==== PlayBlendTreeStateAction ====
Play a blend tree state.
==== RTCLocationsPreloadAction ====

== Replay ==
==== RecordReplayAction ====
Record a new replay and store in file.
==== PlayReplayAction ====
Play a replay file.
==== PlayGhostAction ====
Play a ghost replay.

== Race ==
==== DisqualifyPlayerAction ====
Disqualify a player.
==== RaceCourseActivateAction ====
Enable race course progress for all players.
==== RaceClockStartAction ====
Start the global race timer for all players.
==== TimePenaltyAction ====
Give a player a time penalty/bonus.
==== BackOnTrackAction ====
When a crash occurs in a race course, the crash is 'not allowed' and the player is teleported to the pylon before his crash.

== Other ==
==== FocusInstrumentAction ====
Focus the camera on a specific instrument. You can highlight the instrument as well (blue glow).

==== RumbleAction ====
Controller rumble effect.
==== CustomAction ====
Create a custom action that uses an external program connected with simconnect.
==== ChangeMarkerTemplateAction ====
Change marker template.
==== ChangeRopeLinkAction ====
Change link on ropes.
==== ChangeNodeAction ====
Change node property.
==== AttachDroppablePayloadAction ====
Attach a droppable payload.
==== AgentMessageAction ====
Send or reveive a message from an agent (ATC?).
==== MissionScoreToLeaderboardAction ====
Try to send mission score to leaderboard. Not (yet) supported for unofficial missions.
==== ShowLogbookAction ====
Show the logbook.
==== FilterInputKeyAction ====
Change input key processing.

{{Template:Navbox-Mission-Creation-MSFS}}

Reverse Polish Notation

2021-12-11T22:34:31Z

Mr LiamT: /* If, Else construction */ fix typo

{{Infobox-Applicable-FSVersion
| MSFS = true
| FSXI = false
| P3D5 = false
| P3D4 = false
| P3D3 = false
| P3D2 = false
| P3D = false
| FSW = false
| FSXSE = false
| FSXA = false
| FSX = false
| FS2004 = false
| FS2002 = false
| XP11 = false
| XP10 = false
| XP9 = false
}}
Reverse Polish Notation, or RPN, is a way to write down formulas. It is used in MSFS for gauges, [https://docs.flightsimulator.com/html/index.htm#t=Content_Configuration%2FModels%2FModelBehaviors%2FModel_Behaviors.htm model behaviors], and in mission scripts for [[Property Trigger|PropertyTriggers]], [[Proximity Trigger|ProximityTriggers]], and [[MSFS Mission Script - Calculator|Calculators]].

'''The [https://docs.flightsimulator.com/html/index.htm#t=Additional_Information%2FReverse_Polish_Notation.htm documentation] on RPN thoroughly explains how it works.
'''

== Mission Script Elements that use RPN ==
{|class='wikitable'
|[[MSFS_Mission_Script_-_Calculator|Calculator]]
|-
|[[Property_Trigger|PropertyTrigger]]
|-
|[[Execute_RPN_Action|ExecuteRPNAction]]
|}

== Examples ==
=== Changing a variable ===
You can change a variable with RPN code in a [[MSFS_Mission_Script_-_Calculator|Calculator]] or [[Execute RPN Action]].
1800 (>X:VariableToChange)
This example changes the variable <code>VariableToChange</code> to 1800.

=== If, Else construction ===
(condition) if{this} els{that}
If the condition is true, the formula will become <code>{this}</code>, otherwise it will become <code>{that}</code>.

Reverse Polish Notation

2021-12-11T22:33:53Z

Mr LiamT: Add example for if else construction

{{Infobox-Applicable-FSVersion
| MSFS = true
| FSXI = false
| P3D5 = false
| P3D4 = false
| P3D3 = false
| P3D2 = false
| P3D = false
| FSW = false
| FSXSE = false
| FSXA = false
| FSX = false
| FS2004 = false
| FS2002 = false
| XP11 = false
| XP10 = false
| XP9 = false
}}
Reverse Polish Notation, or RPN, is a way to write down formulas. It is used in MSFS for gauges, [https://docs.flightsimulator.com/html/index.htm#t=Content_Configuration%2FModels%2FModelBehaviors%2FModel_Behaviors.htm model behaviors], and in mission scripts for [[Property Trigger|PropertyTriggers]], [[Proximity Trigger|ProximityTriggers]], and [[MSFS Mission Script - Calculator|Calculators]].

'''The [https://docs.flightsimulator.com/html/index.htm#t=Additional_Information%2FReverse_Polish_Notation.htm documentation] on RPN thoroughly explains how it works.
'''

== Mission Script Elements that use RPN ==
{|class='wikitable'
|[[MSFS_Mission_Script_-_Calculator|Calculator]]
|-
|[[Property_Trigger|PropertyTrigger]]
|-
|[[Execute_RPN_Action|ExecuteRPNAction]]
|}

== Examples ==
=== Changing a variable ===
You can change a variable with RPN code in a [[MSFS_Mission_Script_-_Calculator|Calculator]] or [[Execute RPN Action]].
1800 (>X:VariableToChange)
This example changes the variable <code>VariableToChange</code> to 1800.

=== If, Else construction ===
(condition) if{this} els{that}
If the condition is true, the condition will be <code>{this}</code>, otherwise it will be <code>{that}</code>.

MSFS Mission Script - Calculator

2021-12-11T22:30:30Z

Mr LiamT: Add explanation for calculator

Reverse Polish Notation

2021-12-11T21:39:18Z

Mr LiamT: Added section on relevant mission script elements

Reverse Polish Notation

2021-12-11T17:20:08Z

Mr LiamT: Add an example section

{{Infobox-Applicable-FSVersion
| MSFS = true
| FSXI = false
| P3D5 = false
| P3D4 = false
| P3D3 = false
| P3D2 = false
| P3D = false
| FSW = false
| FSXSE = false
| FSXA = false
| FSX = false
| FS2004 = false
| FS2002 = false
| XP11 = false
| XP10 = false
| XP9 = false
}}
Reverse Polish Notation, or RPN, is a way to write down formulas. It is used in MSFS for gauges, [https://docs.flightsimulator.com/html/index.htm#t=Content_Configuration%2FModels%2FModelBehaviors%2FModel_Behaviors.htm model behaviors], and in mission scripts for [[Property Trigger|PropertyTriggers]], [[Proximity Trigger|ProximityTriggers]], and [[MSFS Mission Script - Calculator|Calculators]].

'''The [https://docs.flightsimulator.com/html/index.htm#t=Additional_Information%2FReverse_Polish_Notation.htm documentation] on RPN thoroughly explains how it works.
'''

== Examples ==
=== Changing a variable ===
You can change a variable with RPN code in a [[MSFS_Mission_Script_-_Calculator|Calculator]] or [[Execute RPN Action]].
1800 (>X:VariableToChange)
This example changes the variable <code>VariableToChange</code> to 1800.

BushMissionGen

2021-12-11T17:09:10Z

Mr LiamT: Update version

[[Category:Tools]]
{{Infobox-Applicable-FSVersion
| MSFS = true
| FSXI = false
| P3D5 = false
| P3D4 = false
| P3D3 = false
| P3D2 = false
| P3D = false
| FSW = false
| FSXSE = false
| FSXA = false
| FSX = false
| FS2004 = false
| FS2002 = false
| XP11 = false
| XP10 = false
| XP9 = false
}}
{{Infobox-Software
| name = BushMissionGen
| logo =
| screenshot = [[File:Bushmissiongen-screenshot-flightsim-to.jpeg|thumb|]]
| caption =
| collapsible =
| author = f99mlu
| developer =
| released = 18-11-2020
| latest release version = 3.12
| latest release date = 09-12-2021
| frequently updated = Yes
| programming language = Java
| operating_system = Windows
| operating_system_desc =
| platform =
| size = 17.91MB
| language = English
| status = Under development
| genre = MSFS
| license =
| website = [https://flightsim.to/file/3681/bushmissiongen Flightsim.to page]
}}
{{Blockquote|1=You can use BushMissionGen to create bushtrips and landing challenges. The tool generates all the directories and files needed, including default single color images, to compile a bush mission or landing challenge. The input file is a single text or XLSX file containing waypoint names, coordinates, generic mission data, nav log texts, etc. It can be generated by the tool from an existing flight plan (PLN file exported from Little Navmap) or from a sample file. Waypoints can also be read from a Little Navmap file (.LNMPLN) where navlog texts are present in the comments. There are many options to use to trigger failures, warnings, play WAV files or TTS and much more. Now even airport/runway creation is included!}}
::By f99mlu, from [https://flightsim.to/file/3681/bushmissiongen flightsim.to].

{{:Transclusion_Mission_development_tools}}

BushTripInjector

2021-12-11T17:07:41Z

Mr LiamT: Update version

[[Category:Tools]]
{{Infobox-Applicable-FSVersion
| MSFS = true
| FSXI = false
| P3D5 = false
| P3D4 = false
| P3D3 = false
| P3D2 = false
| P3D = false
| FSW = false
| FSXSE = false
| FSXA = false
| FSX = false
| FS2004 = false
| FS2002 = false
| XP11 = false
| XP10 = false
| XP9 = false
}}
{{Infobox-Software
| name = BushTripInjector
| logo = [[File:BushTripInjector.png|70px]]
| screenshot = [[File:BushTripInjector-screenshot.jpg|thumb|]]
| caption =
| collapsible =
| author = BuffyGC
| developer =
| released = 28-11-2020
| latest release version = 1.0.3.2095
| latest release date = 10-13-2021
| frequently updated = Yes
| programming language =
| operating_system = Windows
| operating_system_desc =
| platform =
| size = 8.29MB
| language = English
| status = Under development
| genre = MSFS
| license =
| website = [https://flightsim.to/file/4131/bushtripinjector Flightsim.to page]
[https://www.bushtripinjector.de/ Homepage]
}}
{{Blockquote|1=BushTripInjector generates fully functional bush trips from LittleNavMap flight plans. Missing texts are automatically added meaningfully. No search for coordinates or heights for the runway or waypoints. Briefing images as well as images of the runways for the NavLog are generated. The program is all GUI controlled and you don't have to worry about formatting. No XML or programming skills required. QuickStartGuide is included.}}
::By BuffyGC, from [https://flightsim.to/file/3681/bushmissiongen flightsim.to].

{{:Transclusion_Mission_development_tools}}

Count Action

2021-12-11T16:31:59Z

Mr LiamT: Created page for count action

MSFS Mission Script - Actions

2021-12-11T16:27:14Z

Mr LiamT: /* PlayFlightRecordingAction */ Add link to the simobject/AI page

[[Category:MSFS_Mission_Script]]

{{:Ambox-Content-WIP}}

{{Infobox-Applicable-FSVersion
| MSFS = true
| FSXI = false
| P3D5 = false
| P3D4 = false
| P3D3 = false
| P3D2 = false
| P3D = false
| FSW = false
| FSXSE = false
| FSXA = false
| FSX = false
| FS2004 = false
| FS2002 = false
| XP11 = false
| XP10 = false
| XP9 = false
}}

{{:Transclusion_MSFS_Mission_Script}}

== Action queue ==
All actions are fired in the order they’re listed in the ObjectReferenceList of the trigger that fired. This is important, because Dialog actions take time to play and will delay any actions that follow them. If a delay is set on a Dialog action, then the next action in the queue will be delayed by that amount. You can arrange the order in which actions in a given queue fire by changing the order manually in the .xml.

== Common actions ==
[[Object Activation Action|ObjectActivationAction]], [[Dialog Action|DialogAction]], [[Change Assistance Item Action|ChangeAssistanceItemAction]], [[Failure Action|FailureAction]], [[Adjust Payload Action|AdjustPayloadAction]], [[Refill Action|RefillAction]], [[MSFS_Mission_Script_-_Flow_states#FlowStateAction|FlowStateAction]].

== General attributes ==
Actions have a few general attributes:
=== Immediate ===
'''True:''' This action will start immediately<br>
'''False:''' This action will wait for other actions to complete. The order is determined by the order the actions are listed in the trigger. This can be changed by manually editing the order in the '''ObjectReference''' section of the element in the mission .xml.
=== BreakOnExecute ===
Official description: "Code break if action is executed". Not sure what that means
=== TargetPlayer ===
The target player refers to the target of an action in a multiplayer mission. Action Target can be the GUID of a particular player or team, or you can use one of the specially defined guids to refer to relative targets:
{| class="wikitable"
|Local User
|{8B7615FA-BBBF-4baa-B959-5EF4F59BB575}
|-
|All Players
|{D09ADD85-4CA8-4be9-939C-4544BA259DA2}
|-
|Trigger
|{9A82F89B-F271-4285-AE90-1F733945D975}
|-
|All Players Except Trigger
|{D2764AC8-FBB3-4b9b-9721-3C3EA0CB402B}
|}

== Mission logic ==
==== [[Object Activation Action|ObjectActivationAction]] ====
Very useful action to (de)activate objects such as triggers and InGameMarkers.
==== [[Random_Action|RandomAction]] ====
Randomly executes one action from a list. First, the action has a probability that any action is executed at all. If it does execute, it randomly chooses one action that will execute.

==== ExecuteRPNAction ====
Execute RPN code.
==== SkipAction ====
Skip an action.
==== StopObjectActionQueueAction ====
Stop action queues of referenced objects
==== ExecuteListAction ====
Execute a list of action
==== WaitAction ====
Action that does nothing... for a predefined time. You can use this to delay the next items in an actionQeue.

== Actions related to a trigger ==
==== [[Count Action|CountAction]] ====
Changes the count of a [[Counter_Trigger|CounterTrigger]]
==== [[Reset Timer Action|ResetTimerAction]] ====
Reset the timer to the StartTime.
==== [[Timer Adjust Action|TimerAdjustAction]] ====
Adjusts the time of a [[Timer Trigger|TimerTrigger]] up or down.

== Action related to [[MSFS Mission Script - Mission objects|Mission objects]] ==
==== [[(Sub)Goal_Resolution_Action|GoalResolutionAction & SubGoalResolutionAction]] ====
Changes the state of a [[MSFS_Mission_Script_-_Mission_objects#Goals|(sub)goal]].
==== [[Grant Reward Action|GrantRewardAction]] ====
Untested.
==== [[Point Of Interest Activation Action|PointOfInterestActivationAction]] ====
(De)activates a [[point of interest]]
==== POIChangeModelAction ====
Unknown.

== Sound ==
==== [[Dialog Action|DialogAction]] ====
Plays dialog for the copilot and atc. It can use sound files or text-to-speech (TTS). The dialogAction can also show subtitles.
==== InstructorDialogAction ====
Same as a DialogAction, but allows for a male and female voice, depending on the player's selected instructor in the settings.
==== OneShotSoundAction ====
Plays specified sound file. Doesn't seem to work in MSFS.
==== PlayListAction ====
Plays through a list of sound files. Doesn't seem to work in MSFS.
==== PlaySoundAction ====
Play a sound in 3D space. Uses a WWise event.
==== StopSoundAction ====
Stop a sound.
==== SoundEffectAction ====
Sets sound effects. Doesn't seem to work in MSFS.
==== RTPCAction ====
Send a WWise RTPC.

== Player/Aircraft ==
==== [[Change Assistance Item Action|ChangeAssistanceItemAction]] ====
Changes specific assistance items throughout the mission.
==== [[Failure Action|FailureAction]] ====
Fail a system (e.g., fuel pump, gear, altimeter, radios).
==== [[Adjust Payload Action|AdjustPayloadAction]] ====
Set or adjust the weight on a payload station (weight of pilot, passengers, baggage, etc).
==== [[Refill Action|RefillAction]] ====
Add or subtract percent of a substance (e.g., fuel).
==== ChangeObjectTypeAction ====
Change an object to a different type.
==== [[Request Teleport Action|RequestTeleportAction]] ====
Request a teleport.
==== RequestTeleportCameraAction ====
Teleport current camera to a position given in a CFG file (e.g, close instrument view, wide cockpit view, gear view).
==== SkipTimeAction ====
Skip time.

== Action related to AI / Simobjects ==
==== [[AI Take Controls Action|AITakeControlsAction]] ====
Changes control of the users' plane between user and AI.
==== [[Send Message To AI Action|SendMessageToAIAction]] ====
Currently useless for missions. See [https://docs.flightsimulator.com/html/Content_Configuration/Environment/Living_World/Airport_Services/Service_And_IdleWorker_Script_Definitions.htm?rhhlterm=sendmessagetoaiaction#h2 documentation].
==== [[Activate Waypoints Action|ActivateWaypointsAction]] ====
Send waypoints to a [[Simobject]] for the AI to follow.
==== WaypointsFromAnotherWaypointAction ====
Get waypoint list for another ActivateWaypointsAction.
==== PlayFlightRecordingAction ====
Plays back recording for the [[MSFS_Mission_Script_-_Sim_Objects#AirplanePlaybackAI|AirplanePlaybackAI]].

==== SpawnAction ====

== [[MSFS_Mission_Script_-_Flow_states|Flowstate]] ==
==== FlowEventAction ====
==== FlowStateAction ====
==== TimerTriggerFlowStateAction ====
==== TransitionAction ====
==== ToggleVisibilityAction ====

== [[MSFS_Mission_Script_-_Events|Event]] ==
==== EventTriggerActivationAction ====
==== EventTriggerAction ====
==== EventAction ====

== Animation / effects / RTC ==
==== [[Fade To Color Action|FadeToColorAction]] ====
Fades a color over the whole viewport. Useful for teleports and testing.
==== AttachEffectAction ====
Attach a visual effect to an object (e.g., plane, simobject).
==== PlayAnimationAction ====
Play an animation.
==== PlayBlendTreeStateAction ====
Play a blend tree state.
==== RTCLocationsPreloadAction ====

== Replay ==
==== RecordReplayAction ====
Record a new replay and store in file.
==== PlayReplayAction ====
Play a replay file.
==== PlayGhostAction ====
Play a ghost replay.

== Race ==
==== DisqualifyPlayerAction ====
Disqualify a player.
==== RaceCourseActivateAction ====
Enable race course progress for all players.
==== RaceClockStartAction ====
Start the global race timer for all players.
==== TimePenaltyAction ====
Give a player a time penalty/bonus.
==== BackOnTrackAction ====
When a crash occurs in a race course, the crash is 'not allowed' and the player is teleported to the pylon before his crash.

== Other ==
==== FocusInstrumentAction ====
Focus the camera on a specific instrument. You can highlight the instrument as well (blue glow).

==== RumbleAction ====
Controller rumble effect.
==== CustomAction ====
Create a custom action that uses an external program connected with simconnect.
==== ChangeMarkerTemplateAction ====
Change marker template.
==== ChangeRopeLinkAction ====
Change link on ropes.
==== ChangeNodeAction ====
Change node property.
==== AttachDroppablePayloadAction ====
Attach a droppable payload.
==== AgentMessageAction ====
Send or reveive a message from an agent (ATC?).
==== MissionScoreToLeaderboardAction ====
Try to send mission score to leaderboard. Not (yet) supported for unofficial missions.
==== ShowLogbookAction ====
Show the logbook.
==== FilterInputKeyAction ====
Change input key processing.

{{Template:Navbox-Mission-Creation-MSFS}}

MSFS Mission Script - Sim Objects

2021-12-11T16:25:48Z

Mr LiamT: Added explanation for the container element and AI properties

[[Category:MSFS_Mission_Script]]

{{:Ambox-Content-WIP}}

{{Infobox-Applicable-FSVersion
| MSFS = true
| FSXI = false
| P3D5 = false
| P3D4 = false
| P3D3 = false
| P3D2 = false
| P3D = false
| FSW = false
| FSXSE = false
| FSXA = false
| FSX = false
| FS2004 = false
| FS2002 = false
| XP11 = false
| XP10 = false
| XP9 = false
}}
You can add planes and other simobjects to your mission.
{{:Transclusion_MSFS_Mission_Script}}

== Container ==
{{Infobox-MSFS-Script-Element
| category = SimObjects
| name = Container
| short-descr = Container for a SimObject
}}
!ContainerTitle
|Name of the container, link with SimObject.
|-
!MDLGuid
|GUID of the SimObject.
|-
!ContainerID
|A number ID used to link with the Flight File.
|-
!UseRegionContainerType
|Is the SimObject adapted to the region (for airport vehicles).
|-
!SimplifiedSimMode
|You can set the level of simulation for this SimObject.
|-
!EngineStarted
|You can easily toggle the engines.
|-
!IdentificationNumber
|Plane registration?
|-
!LabelMode
|Only for FSX.
|-
!DontCreateSimSound
|You can make the SimObject silent.
|-
!Effect
|Attach an effect to the SimObject.
|-
!World Position
|You can set the initial position.
|-
!Orientation
|You can set the initial orientation.
|-
!Velocity
|You can set the initial velocity.
|-
!TrafficDB
|Link to a traffic database file?
|-
!Add(Co)Pilot
|
{{Infobox-MSFS-Script-Element-End}}

=== Setting up a container ===
All simobjects have to be set up with a container element. Add a container in the [[MSFS_Script_Editor|Script Editor]]. You have to link the container to a simobject. Open the simobjects panel by clicking <code>Script Editor > View > Sim Objects</code>. Link the ''ContainerTitle'' by clicking the box and, while keeping the mouse pressed, drag it to the simobject you want to select:

[[File:Container_-_link_container_title.png|700px]]

Do the same for the ''MDLGuid'':

[[File:Container_-_link_MDLGuid.png|700px]]

==== Flight File Definitions ====
For planes, you can add further definitions in the [[Flight_file_(MSFS)|Flight File]]. Pick a number for the ''ContainerID'', for example we'll use <code>40923</code>. In the flight file, you can add definitions for the same variables as the player's plane, but instead of <code>.0</code>, you use the ''ContainerID'':

[Sim.40923]
Sim=Savage Cub 01 Livery
SimFile=taxi.flt

[Payload.40923]
PayloadList= 300.0

== AI ==
You can set the AI of your simobject. In the container, choose an ''AIType'' and select an AI:
{|class="wikitable"
!AI name
!Description
|-
![[#AircraftAI|AircraftAI]]
|Most extensive AI. Used for planes.
|-
![[#ParameterAI|AircraftAI]]
|Simpler AI. Used for all AI types.
|-
![[#IdleWorkerAI|IdleWorkerAI]]
|Simpler AI. Used for walking human AI.
|-
|[[#HumanPilotAI|HumanPilotAI]]
|Used for human models piloting a SimObject. No effect on the vehicle itself.
|-
|[[#AirplanePlaybackAI|AirplanePlaybackAI]]
|Used for playing back a flight recording. Not really AI.
|}

=== Basic AI elements ===
{|class="wikitable"
!Property name
!Description
|-
|Unit_Mode
|Determines the current AI mode.
|-
|WaypointList
|List of waypoints to follow.
|-
|GroundCruiseSpeed
|Cruise speed in knots for taxiing.
|-
|GroundTurnSpeed
|Speed in knots to slow to when making sharp turns.
|-
|GroundTurnTime
|Seconds to take for making a 90 degree turn.
|-
|YieldToUser
|Determine if the AI stops when the player is in the way.
|-
|WaypointTouchDistance
|Distance in meters at which Aircraft AI considers waypoint to be reached.
|-
|KeepLastHeading
|The AI should arrive with the same heading as the heading between last and before last waypoint.
|-
|CanReverse
|Determines if the waypoint AI reverses if it missed its waypoint.
|}

=== AircraftAI ===
{|class="wikitable"
!Property name
!Description
|-
|Schedule
|Create a schedule for AI flights.
|-
|ICAOIdent
|
|-
|[[#List_of_Aircraft_AI_States|AircraftAIState]]
|Extensive states for the AI, corresponding to flight stages.
|-
|SimDisableTimer
|
|-
|RunwayIndex
|Index of the runway.
|-
|Flags
|
|-
|MaxBank
|Maximum bank used when turning between waypoints in degrees.
|-
|Pattern_Entry
|
|-
|PendingMenuSelection
|
|-
|TimeToTransmit
|
|-
|DistanceToDestination
|
|-
|LegLength
|
|-
|AssignedHeading
|
|-
|AssignedAltitude
|
|-
|AssignedAirspeed
|
|-
|FinalApproachCourse
|
|-
|CirclingAltitude
|
|-
|ParkingIndex
|Index of the parking spot.
|-
|RunwayPatternAlt
|
|-
|CTAFAnnouncementTimer
|
|}

You can also add some parameters for the ''TaxiAI'', ''TakeoffAI'', and ''LandingAI''.

==== TaxiAI ====
{|class="wikitable"
!Property name
!Description
|-
|TaxiRoute
|Taxi route at a specific airport.
|-
|NextWaypoint
|Next taxi waypoint.
|-
|CurrentWaypoint
|Waypoint the AI is now taxiing towards
|-
|CurrentWaypointLLA
|Coordinates of the current waypoint.
|-
|PrevWaypoint
|Previous taxi waypoint.
|-
|Destination
|Coordinates of the destination.
|-
|HoldClearPoint
|Taxipoint at which to hold.
|-
|HoldShortPoint
|Taxipoint at which to hold.
|-
|HoldFlags
|
|-
|HoldStartTime
|
|-
|HasRunwayHeading
|Is the plane aligned with the runway?
|-
|IsPushingBack
|Is the plane currently pushing back?
|-
|PassOncoming
|Can we pass oncoming traffic on the right? (For road vehicles)
|-
|PauseAtHoldshort
|Pause at holdshort before crossing a runway
|-
|NoConflict
|Ignore and is ignored by the traffic conflict system
|}

==== TakeoffAI ====
{|class="wikitable"
!Property name
!Description
|-
|RunwayHeading
|Runway Heading in degrees.
|-
|AITakeoffMode
|Current state of the takeoff.
|}

==== LandingAI ====
{|class="wikitable"
!Property name
!Description
|-
|AILandingMode
|Current state of the landing.
|-
|InitialFlaps
|Minimum flaps position to use during landing.
|-
|ThresholdLLA
|Coordinates of the point where we want to touch down.
|-
|RunwayLength
|Length of Runway in Nautical Miles
|-
|RunwayAlt
|Runway Altitude in feet MSL
|-
|ApproachSlope
|
|-
|InitialAlt
|Approach altitude Feet AGL
|-
|MaxInterceptAngle
|
|}

=== HumanPilotAI ===

=== AirplanePlaybackAI ===
{|class="wikitable"
!Property name
!Description
|-
|Playing
|Whether or not the recorded flight is being played back by the [[Play_Flight_Recording_Action|PlayFlightRecordingAction]] or not.
|-
|filename
|Filename of the playback file.
|-
|TimeStamp
|Time offset of playback when saved.
|}

=== List of Aircraft AI States ===
{| class="wikitable"
!Aircraft AI State Name
|-
|WAIT_INIT_CONFIRM
|-
|SLEEP
|-
|FILE_FLIGHT_PLAN
|-
|SUPPORT_PREFLIGHT
|-
|IFR_CLEARANCE
|-
|PUSH_BACK_BEGIN
|-
|PUSH_BACK_CONTINUE
|-
|ENGINE_START
|-
|PRE_TAXI_FOR_TAKEOFF
|-
|TAXI_FOR_TAKEOFF
|-
|TAXI_ONTO_RUNWAY
|-
|TAKEOFF
|-
|TOUCH_AND_GO_DEPARTURE
|-
|ENROUTE_AS_FILED
|-
|TRAFFIC_PATTERN
|-
|LANDING
|-
|LANDING_ROLLOUT
|-
|GO_AROUND
|-
|TAXI_TO_PARKING
|-
|ENGINE_SHUTDOWN
|-
|SUPPORT_POSTFLIGHT
|-
|TAXI_TO_REFUEL
|-
|SIMPLE_FLIGHT
|-
|SIMPLE_LANDING
|-
|SIMPLE_TAKEOFF
|-
|WAIT_FOR_ENGINE_START
|-
|TAXI_HOLDSHORT
|-
|FLY_UNTIL_NEXT_EVENT
|-
|WAIT_FOR_ENGINE_SHUTDOWN
|-
|}

{{Template:Navbox-Mission-Creation-MSFS}}

File:Container - link MDLGuid.png

2021-12-11T12:04:18Z

Mr LiamT:

File:Container - link container title.png

2021-12-11T12:04:06Z

Mr LiamT:

MSFS Mission Script - Actions

2021-12-10T23:16:38Z

Mr LiamT: /* RandomAction */ Update short description and link

[[Category:MSFS_Mission_Script]]

{{:Ambox-Content-WIP}}

{{Infobox-Applicable-FSVersion
| MSFS = true
| FSXI = false
| P3D5 = false
| P3D4 = false
| P3D3 = false
| P3D2 = false
| P3D = false
| FSW = false
| FSXSE = false
| FSXA = false
| FSX = false
| FS2004 = false
| FS2002 = false
| XP11 = false
| XP10 = false
| XP9 = false
}}

{{:Transclusion_MSFS_Mission_Script}}

== Action queue ==
All actions are fired in the order they’re listed in the ObjectReferenceList of the trigger that fired. This is important, because Dialog actions take time to play and will delay any actions that follow them. If a delay is set on a Dialog action, then the next action in the queue will be delayed by that amount. You can arrange the order in which actions in a given queue fire by changing the order manually in the .xml.

== Common actions ==
[[Object Activation Action|ObjectActivationAction]], [[Dialog Action|DialogAction]], [[Change Assistance Item Action|ChangeAssistanceItemAction]], [[Failure Action|FailureAction]], [[Adjust Payload Action|AdjustPayloadAction]], [[Refill Action|RefillAction]], [[MSFS_Mission_Script_-_Flow_states#FlowStateAction|FlowStateAction]].

== General attributes ==
Actions have a few general attributes:
=== Immediate ===
'''True:''' This action will start immediately<br>
'''False:''' This action will wait for other actions to complete. The order is determined by the order the actions are listed in the trigger. This can be changed by manually editing the order in the '''ObjectReference''' section of the element in the mission .xml.
=== BreakOnExecute ===
Official description: "Code break if action is executed". Not sure what that means
=== TargetPlayer ===
The target player refers to the target of an action in a multiplayer mission. Action Target can be the GUID of a particular player or team, or you can use one of the specially defined guids to refer to relative targets:
{| class="wikitable"
|Local User
|{8B7615FA-BBBF-4baa-B959-5EF4F59BB575}
|-
|All Players
|{D09ADD85-4CA8-4be9-939C-4544BA259DA2}
|-
|Trigger
|{9A82F89B-F271-4285-AE90-1F733945D975}
|-
|All Players Except Trigger
|{D2764AC8-FBB3-4b9b-9721-3C3EA0CB402B}
|}

== Mission logic ==
==== [[Object Activation Action|ObjectActivationAction]] ====
Very useful action to (de)activate objects such as triggers and InGameMarkers.
==== [[Random_Action|RandomAction]] ====
Randomly executes one action from a list. First, the action has a probability that any action is executed at all. If it does execute, it randomly chooses one action that will execute.

==== ExecuteRPNAction ====
Execute RPN code.
==== SkipAction ====
Skip an action.
==== StopObjectActionQueueAction ====
Stop action queues of referenced objects
==== ExecuteListAction ====
Execute a list of action
==== WaitAction ====
Action that does nothing... for a predefined time. You can use this to delay the next items in an actionQeue.

== Actions related to a trigger ==
==== [[Count Action|CountAction]] ====
Changes the count of a [[Counter_Trigger|CounterTrigger]]
==== [[Reset Timer Action|ResetTimerAction]] ====
Reset the timer to the StartTime.
==== [[Timer Adjust Action|TimerAdjustAction]] ====
Adjusts the time of a [[Timer Trigger|TimerTrigger]] up or down.

== Action related to [[MSFS Mission Script - Mission objects|Mission objects]] ==
==== [[(Sub)Goal_Resolution_Action|GoalResolutionAction & SubGoalResolutionAction]] ====
Changes the state of a [[MSFS_Mission_Script_-_Mission_objects#Goals|(sub)goal]].
==== [[Grant Reward Action|GrantRewardAction]] ====
Untested.
==== [[Point Of Interest Activation Action|PointOfInterestActivationAction]] ====
(De)activates a [[point of interest]]
==== POIChangeModelAction ====
Unknown.

== Sound ==
==== [[Dialog Action|DialogAction]] ====
Plays dialog for the copilot and atc. It can use sound files or text-to-speech (TTS). The dialogAction can also show subtitles.
==== InstructorDialogAction ====
Same as a DialogAction, but allows for a male and female voice, depending on the player's selected instructor in the settings.
==== OneShotSoundAction ====
Plays specified sound file. Doesn't seem to work in MSFS.
==== PlayListAction ====
Plays through a list of sound files. Doesn't seem to work in MSFS.
==== PlaySoundAction ====
Play a sound in 3D space. Uses a WWise event.
==== StopSoundAction ====
Stop a sound.
==== SoundEffectAction ====
Sets sound effects. Doesn't seem to work in MSFS.
==== RTPCAction ====
Send a WWise RTPC.

== Player/Aircraft ==
==== [[Change Assistance Item Action|ChangeAssistanceItemAction]] ====
Changes specific assistance items throughout the mission.
==== [[Failure Action|FailureAction]] ====
Fail a system (e.g., fuel pump, gear, altimeter, radios).
==== [[Adjust Payload Action|AdjustPayloadAction]] ====
Set or adjust the weight on a payload station (weight of pilot, passengers, baggage, etc).
==== [[Refill Action|RefillAction]] ====
Add or subtract percent of a substance (e.g., fuel).
==== ChangeObjectTypeAction ====
Change an object to a different type.
==== [[Request Teleport Action|RequestTeleportAction]] ====
Request a teleport.
==== RequestTeleportCameraAction ====
Teleport current camera to a position given in a CFG file (e.g, close instrument view, wide cockpit view, gear view).
==== SkipTimeAction ====
Skip time.

== Action related to AI / Simobjects ==
==== [[AI Take Controls Action|AITakeControlsAction]] ====
Changes control of the users' plane between user and AI.
==== [[Send Message To AI Action|SendMessageToAIAction]] ====
Currently useless for missions. See [https://docs.flightsimulator.com/html/Content_Configuration/Environment/Living_World/Airport_Services/Service_And_IdleWorker_Script_Definitions.htm?rhhlterm=sendmessagetoaiaction#h2 documentation].
==== [[Activate Waypoints Action|ActivateWaypointsAction]] ====
Send waypoints to a [[Simobject]] for the AI to follow.
==== WaypointsFromAnotherWaypointAction ====
Get waypoint list for another ActivateWaypointsAction.
==== PlayFlightRecordingAction ====
Plays back recording for AI aircraft.
==== SpawnAction ====

== [[MSFS_Mission_Script_-_Flow_states|Flowstate]] ==
==== FlowEventAction ====
==== FlowStateAction ====
==== TimerTriggerFlowStateAction ====
==== TransitionAction ====
==== ToggleVisibilityAction ====

== [[MSFS_Mission_Script_-_Events|Event]] ==
==== EventTriggerActivationAction ====
==== EventTriggerAction ====
==== EventAction ====

== Animation / effects / RTC ==
==== [[Fade To Color Action|FadeToColorAction]] ====
Fades a color over the whole viewport. Useful for teleports and testing.
==== AttachEffectAction ====
Attach a visual effect to an object (e.g., plane, simobject).
==== PlayAnimationAction ====
Play an animation.
==== PlayBlendTreeStateAction ====
Play a blend tree state.
==== RTCLocationsPreloadAction ====

== Replay ==
==== RecordReplayAction ====
Record a new replay and store in file.
==== PlayReplayAction ====
Play a replay file.
==== PlayGhostAction ====
Play a ghost replay.

== Race ==
==== DisqualifyPlayerAction ====
Disqualify a player.
==== RaceCourseActivateAction ====
Enable race course progress for all players.
==== RaceClockStartAction ====
Start the global race timer for all players.
==== TimePenaltyAction ====
Give a player a time penalty/bonus.
==== BackOnTrackAction ====
When a crash occurs in a race course, the crash is 'not allowed' and the player is teleported to the pylon before his crash.

== Other ==
==== FocusInstrumentAction ====
Focus the camera on a specific instrument. You can highlight the instrument as well (blue glow).

==== RumbleAction ====
Controller rumble effect.
==== CustomAction ====
Create a custom action that uses an external program connected with simconnect.
==== ChangeMarkerTemplateAction ====
Change marker template.
==== ChangeRopeLinkAction ====
Change link on ropes.
==== ChangeNodeAction ====
Change node property.
==== AttachDroppablePayloadAction ====
Attach a droppable payload.
==== AgentMessageAction ====
Send or reveive a message from an agent (ATC?).
==== MissionScoreToLeaderboardAction ====
Try to send mission score to leaderboard. Not (yet) supported for unofficial missions.
==== ShowLogbookAction ====
Show the logbook.
==== FilterInputKeyAction ====
Change input key processing.

{{Template:Navbox-Mission-Creation-MSFS}}

Random Action

2021-12-10T23:15:38Z

Mr LiamT: Created page for random action

[[Category:MSFS Mission Script]]

{{:Ambox-Content-WIP}}

{{Infobox-Applicable-FSVersion
| MSFS = true
| FSXI = false
| P3D5 = false
| P3D4 = false
| P3D3 = false
| P3D2 = false
| P3D = false
| FSW = false
| FSXSE = false
| FSXA = false
| FSX = false
| FS2004 = false
| FS2002 = false
| XP11 = false
| XP10 = false
| XP9 = false
}}
Randomly executes one action from a list. First, the action has a probability that any action is executed at all. If it does execute, it randomly chooses one action that will execute.

{{Infobox-MSFS-Script-Element
| category = Actions
| name = RandomAction
| short-descr = Randomly execute action(s).
}}
!ProbabilityPercent
|Propability that one of the actions will execute. 100% means a random action from the list will always execute.
|-
!Actions
|You can reference an action multiple times to increase its probability.
{{Infobox-MSFS-Script-Element-End}}

== Possible uses ==
* Create different experiences (different dialog, random failures, random location to go to)
* Have something randomly occur in a timespan. Set the ''ProbabilityPercent'' to a low value and have a [[Timer Trigger|TimerTrigger]] trigger the '''RandomAction''' multiple times. The ''ProbabilityPercent'' and frequency of the TimerTrigger will determine the timespan.

== Related ==
* A [[MSFS_Mission_Script_-_Triggers#MenuPromptTrigger|Menu Prompt Trigger]] can also be used to create branching paths in your mission.
{{:Transclusion_MSFS_Mission_Script_-_Actions}}

{{Template:Navbox-Mission-Creation-MSFS}}

MSFS Mission Script - Actions

2021-12-06T18:55:45Z

Mr LiamT: /* FocusInstrumentAction */ Typo

[[Category:MSFS_Mission_Script]]

{{:Ambox-Content-WIP}}

{{Infobox-Applicable-FSVersion
| MSFS = true
| FSXI = false
| P3D5 = false
| P3D4 = false
| P3D3 = false
| P3D2 = false
| P3D = false
| FSW = false
| FSXSE = false
| FSXA = false
| FSX = false
| FS2004 = false
| FS2002 = false
| XP11 = false
| XP10 = false
| XP9 = false
}}

{{:Transclusion_MSFS_Mission_Script}}

== Action queue ==
All actions are fired in the order they’re listed in the ObjectReferenceList of the trigger that fired. This is important, because Dialog actions take time to play and will delay any actions that follow them. If a delay is set on a Dialog action, then the next action in the queue will be delayed by that amount. You can arrange the order in which actions in a given queue fire by changing the order manually in the .xml.

== Common actions ==
[[Object Activation Action|ObjectActivationAction]], [[Dialog Action|DialogAction]], [[Change Assistance Item Action|ChangeAssistanceItemAction]], [[Failure Action|FailureAction]], [[Adjust Payload Action|AdjustPayloadAction]], [[Refill Action|RefillAction]], [[MSFS_Mission_Script_-_Flow_states#FlowStateAction|FlowStateAction]].

== General attributes ==
Actions have a few general attributes:
=== Immediate ===
'''True:''' This action will start immediately<br>
'''False:''' This action will wait for other actions to complete. The order is determined by the order the actions are listed in the trigger. This can be changed by manually editing the order in the '''ObjectReference''' section of the element in the mission .xml.
=== BreakOnExecute ===
Official description: "Code break if action is executed". Not sure what that means
=== TargetPlayer ===
The target player refers to the target of an action in a multiplayer mission. Action Target can be the GUID of a particular player or team, or you can use one of the specially defined guids to refer to relative targets:
{| class="wikitable"
|Local User
|{8B7615FA-BBBF-4baa-B959-5EF4F59BB575}
|-
|All Players
|{D09ADD85-4CA8-4be9-939C-4544BA259DA2}
|-
|Trigger
|{9A82F89B-F271-4285-AE90-1F733945D975}
|-
|All Players Except Trigger
|{D2764AC8-FBB3-4b9b-9721-3C3EA0CB402B}
|}

== Mission logic ==
==== [[Object Activation Action|ObjectActivationAction]] ====
Very useful action to (de)activate objects such as triggers and InGameMarkers.
==== [[Random Action|RandomAction]] ====
Chooses a random action from a list and can have a probability that an action executes.
==== ExecuteRPNAction ====
Execute RPN code.
==== SkipAction ====
Skip an action.
==== StopObjectActionQueueAction ====
Stop action queues of referenced objects
==== ExecuteListAction ====
Execute a list of action
==== WaitAction ====
Action that does nothing... for a predefined time. You can use this to delay the next items in an actionQeue.

== Actions related to a trigger ==
==== [[Count Action|CountAction]] ====
Changes the count of a [[Counter_Trigger|CounterTrigger]]
==== [[Reset Timer Action|ResetTimerAction]] ====
Reset the timer to the StartTime.
==== [[Timer Adjust Action|TimerAdjustAction]] ====
Adjusts the time of a [[Timer Trigger|TimerTrigger]] up or down.

== Action related to [[MSFS Mission Script - Mission objects|Mission objects]] ==
==== [[(Sub)Goal_Resolution_Action|GoalResolutionAction & SubGoalResolutionAction]] ====
Changes the state of a [[MSFS_Mission_Script_-_Mission_objects#Goals|(sub)goal]].
==== [[Grant Reward Action|GrantRewardAction]] ====
Untested.
==== [[Point Of Interest Activation Action|PointOfInterestActivationAction]] ====
(De)activates a [[point of interest]]
==== POIChangeModelAction ====
Unknown.

== Sound ==
==== [[Dialog Action|DialogAction]] ====
Plays dialog for the copilot and atc. It can use sound files or text-to-speech (TTS). The dialogAction can also show subtitles.
==== InstructorDialogAction ====
Same as a DialogAction, but allows for a male and female voice, depending on the player's selected instructor in the settings.
==== OneShotSoundAction ====
Plays specified sound file. Doesn't seem to work in MSFS.
==== PlayListAction ====
Plays through a list of sound files. Doesn't seem to work in MSFS.
==== PlaySoundAction ====
Play a sound in 3D space. Uses a WWise event.
==== StopSoundAction ====
Stop a sound.
==== SoundEffectAction ====
Sets sound effects. Doesn't seem to work in MSFS.
==== RTPCAction ====
Send a WWise RTPC.

== Player/Aircraft ==
==== [[Change Assistance Item Action|ChangeAssistanceItemAction]] ====
Changes specific assistance items throughout the mission.
==== [[Failure Action|FailureAction]] ====
Fail a system (e.g., fuel pump, gear, altimeter, radios).
==== [[Adjust Payload Action|AdjustPayloadAction]] ====
Set or adjust the weight on a payload station (weight of pilot, passengers, baggage, etc).
==== [[Refill Action|RefillAction]] ====
Add or subtract percent of a substance (e.g., fuel).
==== ChangeObjectTypeAction ====
Change an object to a different type.
==== [[Request Teleport Action|RequestTeleportAction]] ====
Request a teleport.
==== RequestTeleportCameraAction ====
Teleport current camera to a position given in a CFG file (e.g, close instrument view, wide cockpit view, gear view).
==== SkipTimeAction ====
Skip time.

== Action related to AI / Simobjects ==
==== [[AI Take Controls Action|AITakeControlsAction]] ====
Changes control of the users' plane between user and AI.
==== [[Send Message To AI Action|SendMessageToAIAction]] ====
Currently useless for missions. See [https://docs.flightsimulator.com/html/Content_Configuration/Environment/Living_World/Airport_Services/Service_And_IdleWorker_Script_Definitions.htm?rhhlterm=sendmessagetoaiaction#h2 documentation].
==== [[Activate Waypoints Action|ActivateWaypointsAction]] ====
Send waypoints to a [[Simobject]] for the AI to follow.
==== WaypointsFromAnotherWaypointAction ====
Get waypoint list for another ActivateWaypointsAction.
==== PlayFlightRecordingAction ====
Plays back recording for AI aircraft.
==== SpawnAction ====

== [[MSFS_Mission_Script_-_Flow_states|Flowstate]] ==
==== FlowEventAction ====
==== FlowStateAction ====
==== TimerTriggerFlowStateAction ====
==== TransitionAction ====
==== ToggleVisibilityAction ====

== [[MSFS_Mission_Script_-_Events|Event]] ==
==== EventTriggerActivationAction ====
==== EventTriggerAction ====
==== EventAction ====

== Animation / effects / RTC ==
==== [[Fade To Color Action|FadeToColorAction]] ====
Fades a color over the whole viewport. Useful for teleports and testing.
==== AttachEffectAction ====
Attach a visual effect to an object (e.g., plane, simobject).
==== PlayAnimationAction ====
Play an animation.
==== PlayBlendTreeStateAction ====
Play a blend tree state.
==== RTCLocationsPreloadAction ====

== Replay ==
==== RecordReplayAction ====
Record a new replay and store in file.
==== PlayReplayAction ====
Play a replay file.
==== PlayGhostAction ====
Play a ghost replay.

== Race ==
==== DisqualifyPlayerAction ====
Disqualify a player.
==== RaceCourseActivateAction ====
Enable race course progress for all players.
==== RaceClockStartAction ====
Start the global race timer for all players.
==== TimePenaltyAction ====
Give a player a time penalty/bonus.
==== BackOnTrackAction ====
When a crash occurs in a race course, the crash is 'not allowed' and the player is teleported to the pylon before his crash.

== Other ==
==== FocusInstrumentAction ====
Focus the camera on a specific instrument. You can highlight the instrument as well (blue glow).

==== RumbleAction ====
Controller rumble effect.
==== CustomAction ====
Create a custom action that uses an external program connected with simconnect.
==== ChangeMarkerTemplateAction ====
Change marker template.
==== ChangeRopeLinkAction ====
Change link on ropes.
==== ChangeNodeAction ====
Change node property.
==== AttachDroppablePayloadAction ====
Attach a droppable payload.
==== AgentMessageAction ====
Send or reveive a message from an agent (ATC?).
==== MissionScoreToLeaderboardAction ====
Try to send mission score to leaderboard. Not (yet) supported for unofficial missions.
==== ShowLogbookAction ====
Show the logbook.
==== FilterInputKeyAction ====
Change input key processing.

{{Template:Navbox-Mission-Creation-MSFS}}

MSFS Mission Script - Actions

2021-12-06T12:57:08Z

Mr LiamT: /* WaitAction */ Fix explanation

[[Category:MSFS_Mission_Script]]

{{:Ambox-Content-WIP}}

{{Infobox-Applicable-FSVersion
| MSFS = true
| FSXI = false
| P3D5 = false
| P3D4 = false
| P3D3 = false
| P3D2 = false
| P3D = false
| FSW = false
| FSXSE = false
| FSXA = false
| FSX = false
| FS2004 = false
| FS2002 = false
| XP11 = false
| XP10 = false
| XP9 = false
}}

{{:Transclusion_MSFS_Mission_Script}}

== Action queue ==
All actions are fired in the order they’re listed in the ObjectReferenceList of the trigger that fired. This is important, because Dialog actions take time to play and will delay any actions that follow them. If a delay is set on a Dialog action, then the next action in the queue will be delayed by that amount. You can arrange the order in which actions in a given queue fire by changing the order manually in the .xml.

== Common actions ==
[[Object Activation Action|ObjectActivationAction]], [[Dialog Action|DialogAction]], [[Change Assistance Item Action|ChangeAssistanceItemAction]], [[Failure Action|FailureAction]], [[Adjust Payload Action|AdjustPayloadAction]], [[Refill Action|RefillAction]], [[MSFS_Mission_Script_-_Flow_states#FlowStateAction|FlowStateAction]].

== General attributes ==
Actions have a few general attributes:
=== Immediate ===
'''True:''' This action will start immediately<br>
'''False:''' This action will wait for other actions to complete. The order is determined by the order the actions are listed in the trigger. This can be changed by manually editing the order in the '''ObjectReference''' section of the element in the mission .xml.
=== BreakOnExecute ===
Official description: "Code break if action is executed". Not sure what that means
=== TargetPlayer ===
The target player refers to the target of an action in a multiplayer mission. Action Target can be the GUID of a particular player or team, or you can use one of the specially defined guids to refer to relative targets:
{| class="wikitable"
|Local User
|{8B7615FA-BBBF-4baa-B959-5EF4F59BB575}
|-
|All Players
|{D09ADD85-4CA8-4be9-939C-4544BA259DA2}
|-
|Trigger
|{9A82F89B-F271-4285-AE90-1F733945D975}
|-
|All Players Except Trigger
|{D2764AC8-FBB3-4b9b-9721-3C3EA0CB402B}
|}

== Mission logic ==
==== [[Object Activation Action|ObjectActivationAction]] ====
Very useful action to (de)activate objects such as triggers and InGameMarkers.
==== [[Random Action|RandomAction]] ====
Chooses a random action from a list and can have a probability that an action executes.
==== ExecuteRPNAction ====
Execute RPN code.
==== SkipAction ====
Skip an action.
==== StopObjectActionQueueAction ====
Stop action queues of referenced objects
==== ExecuteListAction ====
Execute a list of action
==== WaitAction ====
Action that does nothing... for a predefined time. You can use this to delay the next items in an actionQeue.

== Actions related to a trigger ==
==== [[Count Action|CountAction]] ====
Changes the count of a [[Counter_Trigger|CounterTrigger]]
==== [[Reset Timer Action|ResetTimerAction]] ====
Reset the timer to the StartTime.
==== [[Timer Adjust Action|TimerAdjustAction]] ====
Adjusts the time of a [[Timer Trigger|TimerTrigger]] up or down.

== Action related to [[MSFS Mission Script - Mission objects|Mission objects]] ==
==== [[(Sub)Goal_Resolution_Action|GoalResolutionAction & SubGoalResolutionAction]] ====
Changes the state of a [[MSFS_Mission_Script_-_Mission_objects#Goals|(sub)goal]].
==== [[Grant Reward Action|GrantRewardAction]] ====
Untested.
==== [[Point Of Interest Activation Action|PointOfInterestActivationAction]] ====
(De)activates a [[point of interest]]
==== POIChangeModelAction ====
Unknown.

== Sound ==
==== [[Dialog Action|DialogAction]] ====
Plays dialog for the copilot and atc. It can use sound files or text-to-speech (TTS). The dialogAction can also show subtitles.
==== InstructorDialogAction ====
Same as a DialogAction, but allows for a male and female voice, depending on the player's selected instructor in the settings.
==== OneShotSoundAction ====
Plays specified sound file. Doesn't seem to work in MSFS.
==== PlayListAction ====
Plays through a list of sound files. Doesn't seem to work in MSFS.
==== PlaySoundAction ====
Play a sound in 3D space. Uses a WWise event.
==== StopSoundAction ====
Stop a sound.
==== SoundEffectAction ====
Sets sound effects. Doesn't seem to work in MSFS.
==== RTPCAction ====
Send a WWise RTPC.

== Player/Aircraft ==
==== [[Change Assistance Item Action|ChangeAssistanceItemAction]] ====
Changes specific assistance items throughout the mission.
==== [[Failure Action|FailureAction]] ====
Fail a system (e.g., fuel pump, gear, altimeter, radios).
==== [[Adjust Payload Action|AdjustPayloadAction]] ====
Set or adjust the weight on a payload station (weight of pilot, passengers, baggage, etc).
==== [[Refill Action|RefillAction]] ====
Add or subtract percent of a substance (e.g., fuel).
==== ChangeObjectTypeAction ====
Change an object to a different type.
==== [[Request Teleport Action|RequestTeleportAction]] ====
Request a teleport.
==== RequestTeleportCameraAction ====
Teleport current camera to a position given in a CFG file (e.g, close instrument view, wide cockpit view, gear view).
==== SkipTimeAction ====
Skip time.

== Action related to AI / Simobjects ==
==== [[AI Take Controls Action|AITakeControlsAction]] ====
Changes control of the users' plane between user and AI.
==== [[Send Message To AI Action|SendMessageToAIAction]] ====
Currently useless for missions. See [https://docs.flightsimulator.com/html/Content_Configuration/Environment/Living_World/Airport_Services/Service_And_IdleWorker_Script_Definitions.htm?rhhlterm=sendmessagetoaiaction#h2 documentation].
==== [[Activate Waypoints Action|ActivateWaypointsAction]] ====
Send waypoints to a [[Simobject]] for the AI to follow.
==== WaypointsFromAnotherWaypointAction ====
Get waypoint list for another ActivateWaypointsAction.
==== PlayFlightRecordingAction ====
Plays back recording for AI aircraft.
==== SpawnAction ====

== [[MSFS_Mission_Script_-_Flow_states|Flowstate]] ==
==== FlowEventAction ====
==== FlowStateAction ====
==== TimerTriggerFlowStateAction ====
==== TransitionAction ====
==== ToggleVisibilityAction ====

== [[MSFS_Mission_Script_-_Events|Event]] ==
==== EventTriggerActivationAction ====
==== EventTriggerAction ====
==== EventAction ====

== Animation / effects / RTC ==
==== [[Fade To Color Action|FadeToColorAction]] ====
Fades a color over the whole viewport. Useful for teleports and testing.
==== AttachEffectAction ====
Attach a visual effect to an object (e.g., plane, simobject).
==== PlayAnimationAction ====
Play an animation.
==== PlayBlendTreeStateAction ====
Play a blend tree state.
==== RTCLocationsPreloadAction ====

== Replay ==
==== RecordReplayAction ====
Record a new replay and store in file.
==== PlayReplayAction ====
Play a replay file.
==== PlayGhostAction ====
Play a ghost replay.

== Race ==
==== DisqualifyPlayerAction ====
Disqualify a player.
==== RaceCourseActivateAction ====
Enable race course progress for all players.
==== RaceClockStartAction ====
Start the global race timer for all players.
==== TimePenaltyAction ====
Give a player a time penalty/bonus.
==== BackOnTrackAction ====
When a crash occurs in a race course, the crash is 'not allowed' and the player is teleported to the pylon before his crash.

== Other ==
==== FocusInstrumentAction ====
Focus the camera on a specific instrument. You can highlight the isntrument as well.
==== RumbleAction ====
Controller rumble effect.
==== CustomAction ====
Create a custom action that uses an external program connected with simconnect.
==== ChangeMarkerTemplateAction ====
Change marker template.
==== ChangeRopeLinkAction ====
Change link on ropes.
==== ChangeNodeAction ====
Change node property.
==== AttachDroppablePayloadAction ====
Attach a droppable payload.
==== AgentMessageAction ====
Send or reveive a message from an agent (ATC?).
==== MissionScoreToLeaderboardAction ====
Try to send mission score to leaderboard. Not (yet) supported for unofficial missions.
==== ShowLogbookAction ====
Show the logbook.
==== FilterInputKeyAction ====
Change input key processing.

{{Template:Navbox-Mission-Creation-MSFS}}

MSFS Mission Script - Triggers

2021-12-06T12:55:08Z

Mr LiamT: /* EventTrigger */ Add event explanation

MSFS Mission Script - Triggers

2021-12-06T12:08:54Z

Mr LiamT: /* ProximityTrigger */ Add WhileInside explanation

MSFS Mission Script - Triggers

2021-12-06T12:07:57Z

Mr LiamT: /* PropertyTrigger */ Add Simvar explanation

MSFS Mission Script - Actions

2021-12-06T10:48:18Z

Mr LiamT: /* Sound */ Add information about broken actions in MSFS

[[Category:MSFS_Mission_Script]]

{{:Ambox-Content-WIP}}

{{Infobox-Applicable-FSVersion
| MSFS = true
| FSXI = false
| P3D5 = false
| P3D4 = false
| P3D3 = false
| P3D2 = false
| P3D = false
| FSW = false
| FSXSE = false
| FSXA = false
| FSX = false
| FS2004 = false
| FS2002 = false
| XP11 = false
| XP10 = false
| XP9 = false
}}

{{:Transclusion_MSFS_Mission_Script}}

== Action queue ==
All actions are fired in the order they’re listed in the ObjectReferenceList of the trigger that fired. This is important, because Dialog actions take time to play and will delay any actions that follow them. If a delay is set on a Dialog action, then the next action in the queue will be delayed by that amount. You can arrange the order in which actions in a given queue fire by changing the order manually in the .xml.

== Common actions ==
[[Object Activation Action|ObjectActivationAction]], [[Dialog Action|DialogAction]], [[Change Assistance Item Action|ChangeAssistanceItemAction]], [[Failure Action|FailureAction]], [[Adjust Payload Action|AdjustPayloadAction]], [[Refill Action|RefillAction]], [[MSFS_Mission_Script_-_Flow_states#FlowStateAction|FlowStateAction]].

== General attributes ==
Actions have a few general attributes:
=== Immediate ===
'''True:''' This action will start immediately<br>
'''False:''' This action will wait for other actions to complete. The order is determined by the order the actions are listed in the trigger. This can be changed by manually editing the order in the '''ObjectReference''' section of the element in the mission .xml.
=== BreakOnExecute ===
Official description: "Code break if action is executed". Not sure what that means
=== TargetPlayer ===
The target player refers to the target of an action in a multiplayer mission. Action Target can be the GUID of a particular player or team, or you can use one of the specially defined guids to refer to relative targets:
{| class="wikitable"
|Local User
|{8B7615FA-BBBF-4baa-B959-5EF4F59BB575}
|-
|All Players
|{D09ADD85-4CA8-4be9-939C-4544BA259DA2}
|-
|Trigger
|{9A82F89B-F271-4285-AE90-1F733945D975}
|-
|All Players Except Trigger
|{D2764AC8-FBB3-4b9b-9721-3C3EA0CB402B}
|}

== Mission logic ==
==== [[Object Activation Action|ObjectActivationAction]] ====
Very useful action to (de)activate objects such as triggers and InGameMarkers.
==== [[Random Action|RandomAction]] ====
Chooses a random action from a list and can have a probability that an action executes.
==== ExecuteRPNAction ====
Execute RPN code.
==== SkipAction ====
Skip an action.
==== StopObjectActionQueueAction ====
Stop action queues of referenced objects
==== ExecuteListAction ====
Execute a list of action
==== WaitAction ====
Action that does nothing... for a predefined time. You can use this to pause the actionQeue.

== Actions related to a trigger ==
==== [[Count Action|CountAction]] ====
Changes the count of a [[Counter_Trigger|CounterTrigger]]
==== [[Reset Timer Action|ResetTimerAction]] ====
Reset the timer to the StartTime.
==== [[Timer Adjust Action|TimerAdjustAction]] ====
Adjusts the time of a [[Timer Trigger|TimerTrigger]] up or down.

== Action related to [[MSFS Mission Script - Mission objects|Mission objects]] ==
==== [[(Sub)Goal_Resolution_Action|GoalResolutionAction & SubGoalResolutionAction]] ====
Changes the state of a [[MSFS_Mission_Script_-_Mission_objects#Goals|(sub)goal]].
==== [[Grant Reward Action|GrantRewardAction]] ====
Untested.
==== [[Point Of Interest Activation Action|PointOfInterestActivationAction]] ====
(De)activates a [[point of interest]]
==== POIChangeModelAction ====
Unknown.

== Sound ==
==== [[Dialog Action|DialogAction]] ====
Plays dialog for the copilot and atc. It can use sound files or text-to-speech (TTS). The dialogAction can also show subtitles.
==== InstructorDialogAction ====
Same as a DialogAction, but allows for a male and female voice, depending on the player's selected instructor in the settings.
==== OneShotSoundAction ====
Plays specified sound file. Doesn't seem to work in MSFS.
==== PlayListAction ====
Plays through a list of sound files. Doesn't seem to work in MSFS.
==== PlaySoundAction ====
Play a sound in 3D space. Uses a WWise event.
==== StopSoundAction ====
Stop a sound.
==== SoundEffectAction ====
Sets sound effects. Doesn't seem to work in MSFS.
==== RTPCAction ====
Send a WWise RTPC.

== Player/Aircraft ==
==== [[Change Assistance Item Action|ChangeAssistanceItemAction]] ====
Changes specific assistance items throughout the mission.
==== [[Failure Action|FailureAction]] ====
Fail a system (e.g., fuel pump, gear, altimeter, radios).
==== [[Adjust Payload Action|AdjustPayloadAction]] ====
Set or adjust the weight on a payload station (weight of pilot, passengers, baggage, etc).
==== [[Refill Action|RefillAction]] ====
Add or subtract percent of a substance (e.g., fuel).
==== ChangeObjectTypeAction ====
Change an object to a different type.
==== [[Request Teleport Action|RequestTeleportAction]] ====
Request a teleport.
==== RequestTeleportCameraAction ====
Teleport current camera to a position given in a CFG file (e.g, close instrument view, wide cockpit view, gear view).
==== SkipTimeAction ====
Skip time.

== Action related to AI / Simobjects ==
==== [[AI Take Controls Action|AITakeControlsAction]] ====
Changes control of the users' plane between user and AI.
==== [[Send Message To AI Action|SendMessageToAIAction]] ====
Currently useless for missions. See [https://docs.flightsimulator.com/html/Content_Configuration/Environment/Living_World/Airport_Services/Service_And_IdleWorker_Script_Definitions.htm?rhhlterm=sendmessagetoaiaction#h2 documentation].
==== [[Activate Waypoints Action|ActivateWaypointsAction]] ====
Send waypoints to a [[Simobject]] for the AI to follow.
==== WaypointsFromAnotherWaypointAction ====
Get waypoint list for another ActivateWaypointsAction.
==== PlayFlightRecordingAction ====
Plays back recording for AI aircraft.
==== SpawnAction ====

== [[MSFS_Mission_Script_-_Flow_states|Flowstate]] ==
==== FlowEventAction ====
==== FlowStateAction ====
==== TimerTriggerFlowStateAction ====
==== TransitionAction ====
==== ToggleVisibilityAction ====

== [[MSFS_Mission_Script_-_Events|Event]] ==
==== EventTriggerActivationAction ====
==== EventTriggerAction ====
==== EventAction ====

== Animation / effects / RTC ==
==== [[Fade To Color Action|FadeToColorAction]] ====
Fades a color over the whole viewport. Useful for teleports and testing.
==== AttachEffectAction ====
Attach a visual effect to an object (e.g., plane, simobject).
==== PlayAnimationAction ====
Play an animation.
==== PlayBlendTreeStateAction ====
Play a blend tree state.
==== RTCLocationsPreloadAction ====

== Replay ==
==== RecordReplayAction ====
Record a new replay and store in file.
==== PlayReplayAction ====
Play a replay file.
==== PlayGhostAction ====
Play a ghost replay.

== Race ==
==== DisqualifyPlayerAction ====
Disqualify a player.
==== RaceCourseActivateAction ====
Enable race course progress for all players.
==== RaceClockStartAction ====
Start the global race timer for all players.
==== TimePenaltyAction ====
Give a player a time penalty/bonus.
==== BackOnTrackAction ====
When a crash occurs in a race course, the crash is 'not allowed' and the player is teleported to the pylon before his crash.

== Other ==
==== FocusInstrumentAction ====
Focus the camera on a specific instrument. You can highlight the isntrument as well.
==== RumbleAction ====
Controller rumble effect.
==== CustomAction ====
Create a custom action that uses an external program connected with simconnect.
==== ChangeMarkerTemplateAction ====
Change marker template.
==== ChangeRopeLinkAction ====
Change link on ropes.
==== ChangeNodeAction ====
Change node property.
==== AttachDroppablePayloadAction ====
Attach a droppable payload.
==== AgentMessageAction ====
Send or reveive a message from an agent (ATC?).
==== MissionScoreToLeaderboardAction ====
Try to send mission score to leaderboard. Not (yet) supported for unofficial missions.
==== ShowLogbookAction ====
Show the logbook.
==== FilterInputKeyAction ====
Change input key processing.

{{Template:Navbox-Mission-Creation-MSFS}}