MSFS Mission Script - Areas

From FSDeveloper Wiki
Revision as of 12:28, 25 May 2024 by BASys (talk | contribs) (Replaced Applicable-FSVersion for MSFS with MSFS2020, added MSFS2024)
(diff) ← Older revision | Latest revision (diff) | Newer revision → (diff)
Jump to navigationJump to search


Area elements are actually volumes that are placed in the world, except for InGameMarkers, which are POI markers you can easily place in the world.

See MSFS Mission Script for general information about creating a mission script.

General attributes

All areas need do have a defined position in the world and a specific rotation.

Rectangle Area

RectangleArea

Rectangular prism.


Length, Width, and Height Dimensions in meters.
Orientation Don't use, define rotation in the world position.


Cylinder Area

CylinderArea

Cylinder.


CylinderRadius and Height Dimensions in meters.
Orientation Don't use, define rotation in the world position.

Polygon Area

PolygonArea

3D extrusion of an area defined by points.


MinAltitude Base height of the volume. Unit is meters above mean sea level.
Max Altitude Top height of the volume. Unit is meters above mean sea level.
PositionList Ordered list of points that make up the PolygonArea.

Corridor Area

InGameMarker

InGameMarker

3D extrusion of an area defined by points.


Defaul2dParams / Defaul3dParams Click to add the 2d or 3d part of the marker.
Visible Visibility of the marker
NeedIcon Does the marker have an icon? Can be different between 2d and 3d marker.
Text Can be set to text (your own text, can be localized), distance (nm), or altitude (ft amsl).
Scale Best to keep at 1.
2D only
ClampType Don't see a difference.
ClampSize Don't see a difference.
3D only
VerticalLine Does the 3d marker have a vertical line?
BackGroundColor Can't get this to work.

The marker has two parts; a 3d ‘pin’, and a 2d pointer. The 3d pin floats above the defined position and can have a vertical line and an icon. The 2d pointer points to the pin when it isn’t in the field of view of the player.

The 3d pin has three textboxes as shown in the picture. The 2d pointer has one textbox.


Pages relevant to mission creation for MSFS.

Mission structure

Flightplan
Weather definitions
Flight file
Mission script
Triggers
AirportLandingTrigger & AreaLandingTrigger · CounterTrigger · PropertyTrigger · ProximityTrigger · TimerTrigger
Actions
ObjectActivationAction · DialogAction · AdjustPayloadAction · ChangeAssistanceItemAction · FadeToColorAction · RandomAction · RequestTeleportAction · CountAction · ResetTimerAction · TimerAdjustAction · GoalResolutionAction & SubGoalResolutionAction · GrantRewardAction · PointOfInterestActivationAction · ActivateWaypointsAction · AITakeControlsAction · SendMessageToAIAction
Mission objects
Mission definition · Goal · LivingWorldExclusion · Camera
Calculator
Flow states
Events
Areas
Rectangle Area · Cylinder Area · Polygon Area · Corridor Area · InGameMarker
Library objects
Sim objects
RTC

Mission tools

MSFS Script Editor · BushTripInjector · BushMissionGen · MSFSLocalizer · SPB2XML · Little Navmap

Other

Example mission files
Porting FSX Missions to MSFS
Localisation
Click the links to access the topic pages (Default - Opens in same window).