MSFS Mission Script - Flow states - Revision history

BASys: Replaced Applicable-FSVersion for MSFS with MSFS2020, added MSFS2024

2024-05-25T17:28:43Z

Replaced Applicable-FSVersion for MSFS with MSFS2020, added MSFS2024

← Older revision		Revision as of 12:28, 25 May 2024
Line 4:		Line 4:

	{{Infobox-Applicable-FSVersion		{{Infobox-Applicable-FSVersion
	\| ~~MSFS~~ = true		\| MSFS2024 = unknown
			\| MSFS2020 = true
	\| FSXI = false		\| FSXI = false
	\| P3D5 = false		\| P3D5 = false

Mr LiamT: Add flowstates and panel flowevents

2022-01-09T19:41:53Z

Add flowstates and panel flowevents

@@ Line 32: / Line 32: @@
 === List of FlowStates ===
 {| class="wikitable"
-!FlowStateName
+!colspan="2"|FlowStateName
 |-
 |INTRO
@@ Line 38: / Line 41: @@
 |OUTRO
 |-
-|FREEFLIGHT
+|BRIEFING
 |-
-|BUSHTRIP
+|WAITING
 |-
-|LANDINGCHALLENGE
+|TELEPORTTOSTATE
 |-
-|REPLAY
+!Flight stages
 |-
 |PREFLIGHT_GATE
 |-
 |PREFLIGHT_PUSHBACK
@@ Line 67: / Line 80: @@
 |-
 |LANDING_FINAL
 |-
 |LANDING_TAXI
 |-
 |LANDING_GATE
 |-
 |LANDING_REST
 |}
@@ Line 189: / Line 288: @@
 ! colspan="2" | Modifiers
 |-
-|Panelname_FORCE_DISABLED
+|PanelId_FORCE_DISABLED
 |Disable this panel. The user can't select it anymore.
 |-
-|Panelname_FORCE_ENABLED
+|PanelId_FORCE_ENABLED
 |Allow the user to select this panel.
 |-
-|Panelname_SHOW
+|PanelId_SHOW
 |Open the panel.
 |-
-|Panelname_HIDE
+|PanelId_FORCE_SHOW
 |Hide the panel.
 |-
 ! colspan="2" | Panel id's

Mr LiamT: /* List of FlowEvents */

2022-01-08T22:33:03Z

List of FlowEvents

← Older revision		Revision as of 17:33, 8 January 2022
Line 148:		Line 148:
	\|-		\|-
	\|HIDE_MISSION_STARTUP		\|HIDE_MISSION_STARTUP
	\|rowspan="2"\|End the briefing~~. Used to stop the briefing before the replay has ended~~.		\|rowspan="2"\|End the briefing.
	\|-		\|-
	\|END_BRIEFING		\|END_BRIEFING

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

2022-01-08T22:32:24Z

List of FlowEvents: Add events and order into categories

@@ Line 80: / Line 80: @@
 === List of FlowEvents ===
 {| class="wikitable"
 |ATC_MUTE
+|
@@ Line 99: / Line 101: @@
 |-
 |SHOW_NAVLOG
+|
 |-
@@ Line 112: / Line 108: @@
 |START_REPLAY
 |Used to start replay for plane movement in the intro's of landing challenges.
 |-
 |STOP_WATCH_STARTED
@@ Line 145: / Line 132: @@
 |UNACTIVATE_PUSHBACK
+|
 |}
+You can also control the toolbar panels with flowevents. You need to combine the panel id with one of the modifiers like this: <code>PANEL_VFR_MAP_SHOW</code>
 {| class="wikitable"
-! colspan="2" | Panels
+! colspan="2" | Modifiers
 |-
 |Panelname_FORCE_DISABLED
@@ Line 165: / Line 201: @@
 |Hide the panel.
 |-
-! colspan="2" | Panel names
+! colspan="2" | Panel id's
 |-
 |PANEL_CAMERA
@@ Line 200: / Line 236: @@
+|
 |}
 == FlowStateAction ==

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

2022-01-04T15:48:41Z

List of FlowEvents: Add flow events

← Older revision		Revision as of 10:48, 4 January 2022
Line 97:		Line 97:
	\|SET_CAMERA_COCKPIT		\|SET_CAMERA_COCKPIT
	\|Set the camera to the inside cockpit view.		\|Set the camera to the inside cockpit view.
			\|-
			\|SHOW_NAVLOG
			\|
	\|-		\|-
	\|SHOW_MISSION_STARTUP		\|SHOW_MISSION_STARTUP
Line 109:		Line 112:
	\|START_REPLAY		\|START_REPLAY
	\|Used to start replay for plane movement in the intro's of landing challenges.		\|Used to start replay for plane movement in the intro's of landing challenges.
			\|-
			\|SHOW_HUD
			\|
			\|-
			\|HIDE_HUD
			\|
	\|-		\|-
	\|END_BRIEFING		\|END_BRIEFING
	\|End the briefing. Used to stop the briefing before the replay has ended.		\|End the briefing. Used to stop the briefing before the replay has ended.
	\|-		\|-
	\|~~SHOW_HUD~~		\|STOP_WATCH_STARTED
			\|
			\|-
			\|STOP_WATCH_RESETED
			\|
			\|-
			\|ENTER_CURSOR_MODE
			\|
			\|-
			\|EXIT_CURSOR_MODE
	\|		\|
	\|-		\|-
Line 128:		Line 146:
	\|		\|
	\|}		\|}


			You can also control the toolbar panels with flowevents:

	{\| class="wikitable"		{\| class="wikitable"
	! colspan="2" \| Panels		! colspan="2" \| Panels
Line 179:		Line 201:
	\|}		\|}
	Usage example: <code>PANEL_VFR_MAP_SHOW</code>		Usage example: <code>PANEL_VFR_MAP_SHOW</code>


	== FlowStateAction ==		== FlowStateAction ==

Mr LiamT: /* FlowStateAction */ Add explanation for FromSpawn property

2021-11-23T13:51:37Z

FlowStateAction: Add explanation for FromSpawn property

← Older revision		Revision as of 08:51, 23 November 2021
Line 191:		Line 191:
	\|-		\|-
	!FromSpawn		!FromSpawn
	\|True if ~~it is~~ the ~~first~~ state.		\|True if the state starts when the plane is spawned (during loading).
	\|-		\|-
	!StayInStateAfter EndTeleportActions		!StayInStateAfter EndTeleportActions

Mr LiamT: Add replay flowstate and flowevent

2021-11-20T16:51:53Z

Add replay flowstate and flowevent

← Older revision		Revision as of 11:51, 20 November 2021
Line 43:		Line 43:
	\|-		\|-
	\|LANDINGCHALLENGE		\|LANDINGCHALLENGE
			\|-
			\|REPLAY
	\|-		\|-
	\|PREFLIGHT_GATE		\|PREFLIGHT_GATE
Line 101:		Line 103:
	\|HIDE_MISSION_STARTUP		\|HIDE_MISSION_STARTUP
	\|		\|
			\|-
			\|LAUNCH_REPLAY
			\|Used to start replay by the user.
	\|-		\|-
	\|START_REPLAY		\|START_REPLAY
	\|~~Start~~ replay~~. Used~~ for plane movement in the intro's of landing challenges.		\|Used to start replay for plane movement in the intro's of landing challenges.
	\|-		\|-
	\|END_BRIEFING		\|END_BRIEFING

Mr LiamT: /* FlowStateAction */ Fix link for flight file

2021-11-15T09:39:46Z

FlowStateAction: Fix link for flight file

← Older revision		Revision as of 04:39, 15 November 2021
Line 195:		Line 195:
	\|-		\|-
	!ATCAircraft StateName		!ATCAircraft StateName
	\|Probably refers to the ''AcState'' in the ''[ATC_Aircraft.0]'' section of the [[~~Flightplan_~~(MSFS)\|flight definition]] (.FLT) ~~file~~.		\|Probably refers to the ''AcState'' in the ''[ATC_Aircraft.0]'' section of the [[Flight_file_(MSFS)\|flight definition file]] (.FLT).
	\|-		\|-
	!TrafficAircraft StateName		!TrafficAircraft StateName

Mr LiamT: Added explenation for TrafficAircraftStateName

2021-11-13T20:18:56Z

Added explenation for TrafficAircraftStateName

@@ Line 198: / Line 198: @@
 |-
 !TrafficAircraft StateName
+|Probably refers to the [[MSFS_Mission_Script_-_Sim_Objects#List_of_Aircraft_AI_States|AI state]]. Use: ''STATE_AIStateName''<br>(e.g ''STATE_ENROUTE_AS_FILED'').
 |-
 !AvailableIn TimeLine
@@ Line 216: / Line 216: @@
 {{Infobox-MSFS-Script-Element-End}}
 {{Template:Navbox-Mission-Creation-MSFS}}

Mr LiamT: Created page for Flow States

2021-11-13T14:30:51Z

Created page for Flow States

New 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
}}

Flowstates are the different parts of a mission or freeflight such as intro, approach, and parking. Flow events are special actions which control ‘sim-level’ actions such as enabling the VFR map, pausing the simulation, and changing the camera.

You can also use flowstates to start animated (RTC) intros and and outros, like the ones in bushtrips, landing challenges, and freeflight.

{{:Transclusion_MSFS_Mission_Script}}

== Flow states ==

=== List of FlowStates ===
{| class="wikitable"
!FlowStateName
|-
|INTRO
|-
|OUTRO
|-
|FREEFLIGHT
|-
|BUSHTRIP
|-
|LANDINGCHALLENGE
|-
|PREFLIGHT_GATE
|-
|PREFLIGHT_PUSHBACK
|-
|PREFLIGHT_TAXI
|-
|PREFLIGHT_HOLDSHORT
|-
|FLIGHT_RUNWAY
|-
|FLIGHT_INITIAL_CLIMB
|-
|FLIGHT_CLIMB
|-
|FLIGHT_CRUISE
|-
|FLIGHT_DESCENT
|-
|LANDING_APPROACH
|-
|LANDING_FINAL
|-
|LANDING_TAXI
|-
|LANDING_GATE
|-
|LANDING_REST
|}

== Flow events ==

=== List of FlowEvents ===
{| class="wikitable"
|ATC_MUTE
|
|-
|ATC_STOP
|
|-
|ATC_RESUME
|
|-
|PAUSE_SIM
|Pause the sim (actual pause, not live pause).
|-
|UNPAUSE_SIM
|Unpause the sim.
|-
|SET_CAMERA_COCKPIT
|Set the camera to the inside cockpit view.
|-
|SHOW_MISSION_STARTUP
|Show briefing at the beginning of the flight.
|-
|HIDE_MISSION_STARTUP
|
|-
|START_REPLAY
|Start replay. Used for plane movement in the intro's of landing challenges.
|-
|END_BRIEFING
|End the briefing. Used to stop the briefing before the replay has ended.
|-
|SHOW_HUD
|
|-
|BUSHTRIP_LEG_COMPLETED
|
|-
|ASK_CONTINUE_TO_FREE_FLIGHT
|
|-
|AI_SET_LANDING_STATE
|Force landing state.
|-
|UNACTIVATE_PUSHBACK
|
|}
{| class="wikitable"
! colspan="2" | Panels
|-
|Panelname_FORCE_DISABLED
|Disable this panel. The user can't select it anymore.
|-
|Panelname_FORCE_ENABLED
|Allow the user to select this panel.
|-
|Panelname_SHOW
|Open the panel.
|-
|Panelname_HIDE
|Hide the panel.
|-
! colspan="2" | Panel names
|-
|PANEL_CAMERA
|
|-
|PANEL_ATC
|
|-
|PANEL_CONTROLS
|
|-
|PANEL_CHECKLIST
|
|-
|PANEL_FUEL_PAYLOAD
|
|-
|PANEL_GAME_NAVLOG
|
|-
|PANEL_VFR_MAP
|
|-
|PANEL_TELEPORT
|
|-
|PANEL_REPLAY
|
|-
|PANEL_COPILOT
|
|-
|PANEL_OBJECTIVES
|
|}
Usage example: <code>PANEL_VFR_MAP_SHOW</code>

== FlowStateAction ==
{{Infobox-MSFS-Script-Element
| category = Actions
| name = FlowStateAction
| short-descr = FlowState action.
}}
!FirstState
|If true, the state is the first state in the gameflight's flow.
|-
!FromSpawn
|True if it is the first state.
|-
!StayInStateAfter EndTeleportActions
|Stay in the current state after end of teleport.
|-
!FlowStateName
|[[#List_of_FlowStates|Name of the flowstate.]]
|-
!ATCAircraft StateName
|Probably refers to the ''AcState'' in the ''[ATC_Aircraft.0]'' section of the [[Flightplan_(MSFS)|flight definition]] (.FLT) file.
|-
!TrafficAircraft StateName
|
|-
!AvailableIn TimeLine
|
|-
!IsFirstStateIn Timeline
|
|-
!NextState
|Link to the next FlowStateAction.
|-
!PauseOnStart
|
|-
!AutoStateSwitch Enabled
|
{{Infobox-MSFS-Script-Element-End}}

=== Traffic Aircraft State ===

==== List of Traffic Aircraft State Names ====

{| class="wikitable"
!Traffic Aircraft State Name
!Associated FlowState
|-
|STATE_TAXI_FOR_TAKEOFF
|PREFLIGHT_TAXI
|-
|STATE_TAXI_ONTO_RUNWAY
|FLIGHT_RUNWAY
|-
|STATE_ENROUTE_AS_FILED
|FLIGHT_CRUISE
|-
|STATE_TRAFFIC_PATTERN
|LANDING_FINAL
|}

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