View source for Missions - Function Reference

{{Infobox-Applicable-FSVersion
| MSFS2024 = unknown
| MSFS2020 = unknown
| FSXI = unknown
| P3D5 = true
| P3D4 = true
| P3D3 = true
| P3D2 = true
| P3D = true
| FSW = unknown
| FSXSE = true
| FSXA = true
| FSX = true
| FS2004 = unknown
| FS2002 = unknown
| XP11 = unknown
| XP10 = unknown
| XP9 = unknown

}}
{{:Transclusion-Missions-Oneline-Function Reference}}
{{:Transclusion-Missions-Overview-Function Reference}}
{{:Transclusion-Missions-SeeDetail}}

----
= [[Actions ]] =
{{:Transclusion-Missions-Oneline-Actions}}

== [[Generic Action Properties ]] ==
{{:Transclusion-Missions-Oneline-Generic Action Properties}}

== [[Activate Waypoints Action ]] ==
{{:Transclusion-Missions-Oneline-Activate Waypoints Action}}

Both AI objects and 'Living World' mobile scenery can have WaypointLists attached to them. If they do, then the model will move from one waypoint to the next. You can use this action to change the waypoints during the mission, to make these types of object react to the player's actions

== [[Adjust Payload Action ]] ==
{{:Transclusion-Missions-Oneline-Adjust Payload Action}}

This allows you to change the player's payload at a certain point in their aircraft. The payload station number can be found in the corresponding <code>aircraft.cfg</code> file for the player's aircraft, in the <code>[WEIGHT_AND_BALANCE]</code> section.

For example, try using a combination of [[#Random Action]]s, [[#Timer Trigger]]s and AdjustPayloadActions to simulate the effect of the entire New Zealand rugby team starting a brawl in the back or your KingAir 350 just before landing.

The OPT never saves the ObjectReference field of an AdjustPayloadAction. While it's theoretically possible to add or remove payloads from AI, this means it's not really possible unless you hand-edit the XML.

== [[Attach Droppable Payload Action ]] ==
{{:Transclusion-Missions-Oneline-Attach Droppable Payload Action}}

== [[Attach Effect Action ]] ==
{{:Transclusion-Missions-Oneline-Attach Effect Action}}

This attaches a visual effect, one of the ones provided in the Effects folder of FSX, to an AI or scenery object. However, it has some significant limitations.

Only models which have AttachPoints built in can be used with an effect. Very few do. Furthermore, if that attachpoint was created with a particular effect in mind, it can never be used with any other effect. Put simply, you can attach effects to the GEN_SceneryEffect model, which is invisible and so can be placed alongside any static visible model. It is highly unlikely that you can attach an effect to the any of the default AI models. In SP1 only (i.e. not RTM, SP2 or Acceleration) you can attach effects to the player.

== [[Change Object Type Action ]] ==
{{:Transclusion-Missions-Oneline-Change Object Type Action}}

In a more complex mission you might want to make the player fly more than one kind of aircraft. Using this action, you can specify the new container title - found in the aircraft.cfg file - for the type of aircraft you want to change to.

== [[Count Action ]] ==
{{:Transclusion-Missions-Oneline-Count Action}}

This adds a value to a [[#Counter Trigger]]. By setting a negative value for ''Count'', you can subtract.

== [[Custom Action ]] ==
{{:Transclusion-Missions-Oneline-Custom Action}}

These are only useful when working with mission command extensions written using [[SimConnect]]. They pass the ''PayloadString'' value to the extension, which may be either an EXE or a DLL, so that it can perform some kind of action that the normal mission system doesn't support.

== [[Dialog Action]] ==
{{:Transclusion-Missions-Oneline-Dialog Action}}

The main way for you to interact with the mission player, this will display some text on screen and optionally play a sound file. This would typically be a recorded version of the text message.

These messages can be switched off in the simulator settings, so you can't assume that the sound file is enough. Alternatively, the player have the messages enabled but sound disabled, so you also can't assume that the text is enough. If they have both messages ''and'' sound disabled, that's their problem.

The sound file is relative to the "Sound" subfolder of the mission folder.

Do try to make your visible text and recorded speech match; mismatched subtitles get on my nerves :)

== [[Disqualify Player Action]] ==
{{:Transclusion-Missions-Oneline-Disqualify Player Action}}

== [[Failure Action ]] ==
{{:Transclusion-Missions-Oneline-Failure Action}}

Some missions will simulate a system failure and expect the player to deal with it appropriately. Using this action you can make one of the player's aircraft's systems fail (by setting HealthPercent to 0), degrade (HealthPercent < 100) or restore full function (HealthPercent = 100).

== [[Goal Resolution Action ]] ==
{{:Transclusion-Missions-Oneline-Goal Resolution Action}}

These set the state of a [[#Goal Object]] to be one of Pending, Complete or Failed. Only goals which are activated count towards the final result of the mission though, so you can change the list of goals during the mission. When no active goals are pending, the mission finishes.

== [[Grant Reward Action ]] ==
{{:Transclusion-Missions-Oneline-Grant Reward Action}}

In addition to having the mission finish successfully, you may want to issue a [[Rewards|Reward]] to the player for doing something well, or for finding hidden content. Using this action along with a Reward you can add a reward to the player's flight record.

== [[Object Activation Action ]] ==
{{:Transclusion-Missions-Oneline-Object Activation Action}}

Some types of objects, typically Triggers and Scenery, can be activated and deactivated. This is important for the flow of your mission; you should only have the appropriate triggers activated to prevent the player from taking shortcuts. Using this action you can activate and deactivate other objects.

== [[One Shot Sound Action ]] ==
{{:Transclusion-Missions-Oneline-One Shot Sound Action}}

Very simply, this plays a recorded sound when it is called.

== [[Play Animation Action ]] ==
{{:Transclusion-Missions-Oneline-Play Animation Action}}

== [[Play Flight Recording Action]] ==
{{:Transclusion-Missions-Oneline-Play Flight Recording Action}}

== [[Play List Action ]] ==
{{:Transclusion-Missions-Oneline-Play List Action}}

== [[Point Of Interest Activation Action ]] ==
{{:Transclusion-Missions-Oneline-Point Of Interest Activation Action}}

The mission compass is an easy way of showing the player where they are supposed to be next. When you want to add a new [[#Point Of Interest Mission Object|Point of Interest]] to the compass and select it as the current one, use this action.

== [[Random Action]] ==
{{:Transclusion-Missions-Oneline-Random Action}}

This is almost two actions in one. You can set the percentage of the time that you want this action to do anything at all (''ProbabilityPercent''). Additionally, only one of the items in the ''Actions'' list is fired, again at random.

This can be very useful for creating 'chatter' for making transit sections of your mission a little more interesting. You can have a non-''OneShot'' [[#Timer Trigger]], set maybe to 45 seconds, calling a RandomAction with ''ProbabilityPercent'' of 33 and half a dozen [[#Dialog Action]]s attached.

== [[Race Course Start Action]] ==
{{:Transclusion-Missions-Oneline-Race Course Start Action}}

== [[Race Course Activate Action]] ==
{{:Transclusion-Missions-Oneline-Race Course Activate Action}}

== [[Refill Action]] ==
{{:Transclusion-Missions-Oneline-Refill Action}}

== [[ResetTimer Action ]] ==
{{:Transclusion-Missions-Oneline-ResetTimer Action}}

Mainly useful with repeating timers. If you want to check that the player has done something within a certain time, the [[#Timer Trigger]] is fine. However, if you want to use the same TimerTrigger again, the ''StartTime'' needs to be reset to 0. You can't use the [[#Timer Adjust Action]] because it has no 'set' option.

== [[Rumble Action ]] ==
{{:Transclusion-Missions-Oneline-Rumble Action}}

This provides force-feedback in a mission, but only works with XBox rumble-controllers, and not other force-feedback joysticks.

== [[Spawn Action ]] ==
{{:Transclusion-Missions-Oneline-Spawn Action}}

This activates a spawnlist, creating any objects it contains.

== [[Time Penalty Action]] ==
{{:Transclusion-Missions-Oneline-Time Penalty Action}}

== [[Timer Adjust Action ]] ==
{{:Transclusion-Missions-Oneline-Timer Adjust Action}}

Allows you to adjust the time remaining before a [[#Timer Trigger]] fires, by adding, or removing (negative numbers).

----

= [[AI Objects ]] =
{{:Transclusion-Missions-Oneline-AI Objects}}

== [[AircraftAI Object ]] ==
{{:Transclusion-Missions-Oneline-AircraftAI Object}}

== [[TakeoffAI Object ]] ==
{{:Transclusion-Missions-Oneline-TakeoffAI Object}}

== [[LandingAI Object ]] ==
{{:Transclusion-Missions-Oneline-LandingAI Object}}

== [[TaxiAI Object ]] ==
{{:Transclusion-Missions-Oneline-TaxiAI Object}}

== [[GroundVehicleAI Object ]] ==
{{:Transclusion-Missions-Oneline-GroundVehicleAI Object}}

== [[Waypoint List Object  ]] ==
{{:Transclusion-Missions-Oneline-Waypoint List Object}}

== [[Waypoint Object ]] ==
{{:Transclusion-Missions-Oneline-Waypoint Object}}


----

= [[Area Definition Object ]] =
{{:Transclusion-Missions-Oneline-Area Definition Object}}

On some systems, small AreaDefinitions can be missed by the mission system. Normally this only affects slower PCs and faster-moving aircraft. Try to make the smallest dimensions of an AreaDefinition at least 20 meters to avoid problems on slower PCs.

----
= [[Group Object ]] =
{{:Transclusion-Missions-Oneline-Group Object}}



----
= [[Mission Object]] =
{{:Transclusion-Missions-Oneline-Mission Object}}

== [[Camera ]] ==
{{:Transclusion-Missions-Oneline-Camera}}

== [[Attached World Position]] ==
{{:Transclusion-Missions-Oneline-Attached World Position}}

== [[Attached World Object ]] ==
{{:Transclusion-Missions-Oneline-Attached World Object}}

== [[Picture In Picture View Controller]] ==
{{:Transclusion-Missions-Oneline-Picture In Picture View Controller}}

== [[Point Of Interest]] ==
{{:Transclusion-Missions-Oneline-Point Of Interest}}

== [[Realism Overrides]] ==
{{:Transclusion-Missions-Oneline-Realism Overrides}}

== [[Ridge Lift]] ==
{{:Transclusion-Missions-Oneline-Ridge Lift}}

== [[Scenario Metadata]] ==
{{:Transclusion-Missions-Oneline-Scenario Metadata}}

== [[Thermal]] ==
{{:Transclusion-Missions-Oneline-Thermal}}


----
= [[Scenery Objects ]] =
{{:Transclusion-Missions-Oneline-Scenery Objects}}

----
= [[Mobile Scenery Objects ]] =
{{:Transclusion-Missions-Oneline-Mobile Scenery Objects}}

----
= [[Spawn List ]] =
{{:Transclusion-Missions-Oneline-Spawn List}}

This creates new nodes during a mission. You can use it to create visual models in addition to mission actions and triggers. In FSX Acceleration, commands created by a spawnlist can refer to any other object in the mission but in all other versions, including SP2, commands created by a spawnlist ''must'' only refer to other objects in the same spawnlist.


----
= [[Triggers ]] =
{{:Transclusion-Missions-Oneline-Triggers}}

== [[Generic Trigger Properties ]] ==
{{:Transclusion-Missions-Oneline-Generic Trigger Properties}}

All triggers can be marked as Active or Inactive using the ''Activated'' field. An inactive trigger does nothing. The usual way to make your mission storyline is to use the [[#Object Activation Action]] to enable new triggers once the player has achieved a key task.

Triggers can also be marked as ''OneShot'', which defaults to true. This means that the trigger fires once, and once only. Normally this is what you want to happen, but there are some exceptions.

ProximityTriggers have two Action lists; ''OnEnterActions'' and ''OnExitActions''. If it is a ''OneShot'' trigger, only one set of actions will ever be used because after the first set has fired, the trigger will be deactivated. If you want both sets of actions to be used, you have to mark the triggers as not being ''OneShot'' (that is, untick the box).

Another common use for a non-''OneShot'' trigger is a recurring timer, where you want something to happen, say, every two minutes.

If you want to re-use a trigger after it has been fired, but still want it to disable itself after every time, you can use the [[#Object Activation Action]] to re-enable it.

== [[Airport Landing Trigger ]] ==
{{:Transclusion-Missions-Oneline-Airport Landing Trigger}}

Checks that the player, or an AI, has landed or touched down at a specific airport. The associated RunwayFilter object doesn't seem to care which end of the named runway you touch down on; that is, runways 4 and 22 are seen to be the same.

== [[Area Landing Trigger ]] ==
{{:Transclusion-Missions-Oneline-Area Landing Trigger}}

Checks to see that the player, or an AI, has landed or touched down ''anywhere''. This seems to have a lower priority than the [[#Airport Landing Trigger]], so it's common to use this to detect off-airport landings by simply not attaching any AreaRectangle.

== [[Counter Trigger ]] ==
{{:Transclusion-Missions-Oneline-Counter Trigger}}

Simply counts up from 0 to whatever level you tell it to. Use this for things like failing the mission if the player ignores five warnings that they must do something.

== [[Menu Prompt Trigger ]] ==
{{:Transclusion-Missions-Oneline-Menu Prompt Trigger}}

This asks the player to make a choice. It's usually used to give multiple ways of completing a mission by using the different menu items to call [[#Object Activation Action]]s which activate different sets of triggers and goals.

== [[Parking Trigger ]] ==
{{:Transclusion-Missions-Oneline-Parking Trigger}}

== [[Property Trigger ]] ==
{{:Transclusion-Missions-Oneline-Property Trigger}}

One of the more useful triggers, this can check a set of predefined properties of the player or an AI for being higher, lower or equal to a constant value or another property. Properties can also be combined using And/Or/Not, but you need to hand-edit the mission XML to use these groupings.

== [[Proximity Trigger ]] ==
{{:Transclusion-Missions-Oneline-Proximity Trigger}}

A simple but powerful test, this checks that the player or an AI has entered or left a defined area.

== [[Timer Trigger ]] ==
{{:Transclusion-Missions-Oneline-Timer Trigger}}

It's main purpose is to simply wait for a set time and then call an action. However, it can be used for two other things. By setting ''OnScreenTimer'' to True, you get a visible timer in the sim. This can be count-up or count-down, depending on the values of ''StartTime'' and ''StopTime''.

Since this gives visual feedback that the mission system is working, this means it is also a very useful test. If you think that an error is preventing your mission from being loaded at all, create an active, on-screen TimerTrigger. If you get a visible timer, the mission is being run.

----

= [[Goal Object ]] =
{{:Transclusion-Missions-Oneline-Goal Object}}

Each mission must have at least one Goal. When all active Goals are complete or failed, the mission ends. You can change which goals have to be achieved during the mission by using the [[#Object Activation Action]] to switch them on or off.

----
= [[Reward Object ]] =
{{:Transclusion-Missions-Oneline-Reward Object}}

Rewards are used in addition to Goals. The player doesn't need to get all the rewards to finish the mission; in fact, they may not even know that rewards are available. They're just a way of saying "Hey, well done!".

Rewards are [[Rewards|created]] in a separate file to the mission, and must be [[Compiling|compiled]] before they can be used.

----
= [[Disabled Traffic Airport Object ]] =
{{:Transclusion-Missions-Oneline-Disabled Traffic Airport Object}}

This tells the simulator that it should not create any AI traffic at a specific list of airports. You don't want an unplanned 747 bearing down on you when you're in the last few minutes of a two hour long mission, nursing a crippled Cessna back to earth at Heathrow. It can also affect some triggers which may be set up to fire for any aircraft.


== Related ==

=== Internal ===
{{:Transclusion-Missions-Related-Function Types}}

[[Link]] - Description

[[Link]] - Description

=== External ===
{{:Transclusion-Missions-Links-External-Common}}

* [http://www.yoururl.com Site page title] - Description

== Reference ==
'Reference' documents specifically related.

[[Link]] - Description
{{Template:Navbox-Missions-ObjRef}}

[[category:Missions]]
[[Category:Mission Object Reference]]