MSFS Mission Script - Mission objects
 | This page is a work-in-progress. Generic message - Please note some detail may possibly be missing or incorrect. |
| Applicable |
|---|
| MSFS |
| MS Flight |
| LM P3D5 |
| LM P3D4 |
| LM P3D3 |
| LM P3D2 |
| LM P3D |
| FS World |
| FSXSE |
| FSXA |
| FSX |
| FS2004 |
| FS2002 |
| XP11 |
| XP10 |
| XP9 |
Mission elements define a range of things like mission type, goals, world traffic, camera, and thermals. See MSFS Mission Script for general information about creating a mission script.
General mission definitions
Descr
Mission name
SuccessText, FailureText, and AbortedText
Text shown when the mission ends.
ImagePath
Unknown.
SpentTime
Can be read throughout the mission
CrashActions
Actions that excecute when the player crashes. Unknown application.
Score
You can give the user a score and grade. To calculate this you need to use a calculator.
RewardScreen
Change parts of the reward screen
Objectives
| Descr | Name of the objective. Can be localized. |
|---|---|
| ImagePath | Unknown. |
| UniqueRefId | Guid of associated goal. |
| TemplateInstanceId | Unknown. |
| Optional | Is this objective optional for mission completion? |
| TriggerNotification | Unknown. |
| DisplayInRewardScreen | Display this in the score/mission overview of the reward screen (only some mission types). |
| Step | Steps of the objective. Link this with SubGoals. You can link to specific instruments. You can have different texts for players using Joystick, GamePad, or Keyboard and mouse. |
| EventTriggers | Link to an event. |
Mission Types
There are different types of missions, but all of them have Objectives/Goals that will have to be fulfilled to end the mission.
MissionFreeFlight
The mission type used for freeflight is the freest (allows increasing sim speed), but doesn't have a nice endscreen (just the logbook).
Tutorial
This mission type has an endscreen to evaluate mission preformance.
MissionBushTrip
This mission type allows you to make a mission with multiple legs. Autosaves mission (currently a bit broken).
MissionLandingChallenge
This mission type is used for landing challenges.
MissionDiscovery
This mission type is used for discovery flights.
Other mission types (untested)
- MissionLowAltitude (Maybe used for reno airraces?)
- MissionRaceRedBull
- MissionRefueling
- MissionSightingFlight
Goals
For a mission to be completed, all active objectives (that aren't optional) have to be successfully completed. Each mission objective has to be linked to a Goal or SubGoal. Goals can be changed with a (Sub)GoalResolutionAction.
Basic goal.
| Activated | Description |
|---|---|
| GoalState | Current state of a goal. Can be: Pending, Completed, Failed, and Aborted. |
| ResetState OnActivation | Reset goal or subgoal state to Pending on activation. |
| Text | Don't use this, use the description in the objectives of the mission element itself. |
| Order | Order of appearance in UI. |
Other
Camera
A camera object in the world you can position how you want.
LivingWorldExclusion
Useful if you want to get rid of stationary or moving traffic from a road, airport, or water).
PointOfInterest
You can add points of interest to your mission. The points of interest can have an InGameMarker.
Calculator
Calculator
AirportCalculator
Racing / Multiplayer
AllowableContainerList
ConditionRacePoint
GateRacePoint
Player
PylonRacePoint
RaceCourse
RaceInfo
Untested
PictureInPictureViewController
RealismOverrides
RidgeLift
Thermal
VolumeRacePoint
Rope (new in msfs)
- Flightplan
- Weather definitions
- Flight file
- Mission script
- Triggers
- Actions
- ObjectActivationAction · DialogAction · AdjustPayloadAction · ChangeAssistanceItemAction · FadeToColorAction · RandomAction · RequestTeleportAction · CountAction · ResetTimerAction · TimerAdjustAction · GoalResolutionAction & SubGoalResolutionAction · GrantRewardAction · PointOfInterestActivationAction · ActivateWaypointsAction · AITakeControlsAction · SendMessageToAIAction
- Mission objects
- Calculator
- Flow states
- Events
- Areas
- Library objects
- Sim objects
- RTC
