MSFS Mission Script - Flow states: Difference between revisions

From FSDeveloper Wiki
Jump to navigationJump to search
(→‎List of FlowEvents: Add flow events)
(→‎List of FlowEvents: Add events and order into categories)
Line 80: Line 80:
=== List of FlowEvents ===
=== List of FlowEvents ===
{| class="wikitable"
{| class="wikitable"
!colspan="2"|General
|-
|ATC_MUTE
|ATC_MUTE
|
|
Line 99: Line 101:
|-
|-
|SHOW_NAVLOG
|SHOW_NAVLOG
|
|-
|SHOW_MISSION_STARTUP
|Show briefing at the beginning of the flight.
|-
|HIDE_MISSION_STARTUP
|
|
|-
|-
Line 112: Line 108:
|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 the briefing. Used to stop the briefing before the replay has ended.
|-
|-
|STOP_WATCH_STARTED
|STOP_WATCH_STARTED
Line 145: Line 132:
|UNACTIVATE_PUSHBACK
|UNACTIVATE_PUSHBACK
|
|
|-
!colspan="2"|UI
|-
|SHOW_HUD
|
|-
|HIDE_HUD
|
|-
!Briefing
!
|-
|SHOW_MISSION_STARTUP
|Show briefing at the beginning of the flight.
|-
|HIDE_MISSION_STARTUP
|rowspan="2"|End the briefing. Used to stop the briefing before the replay has ended.
|-
|END_BRIEFING
|-
!Loading
!
|-
|SHOW_LOADING
|Show the loading screen.
|-
|HIDE_LOADING
|Hide the loading screen.
|-
!Pause
!
|-
|SHOW_PAUSEMENU
|Show the pause menu.
|-
|HIDE_PAUSEMENU
|Hide the pause menu.
|-
|RESUMEFROMPAUSE
|Resume the game.
|-
!colspan="2"|Racing
|-
|RENO_MENU_SHOW
|-
|START_RENO_RACE_INGAME_DIALOG
|-
|SHOW_RENO_RTC_HUD
|-
|HIDE_RENO_RTC_HUD
|}
|}


 
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>
You can also control the toolbar panels with flowevents:


{| class="wikitable"
{| class="wikitable"
! colspan="2" | Panels
! colspan="2" | Modifiers
|-
|-
|Panelname_FORCE_DISABLED
|Panelname_FORCE_DISABLED
Line 165: Line 201:
|Hide the panel.
|Hide the panel.
|-
|-
! colspan="2" | Panel names
! colspan="2" | Panel id's
|-
|-
|PANEL_CAMERA
|PANEL_CAMERA
Line 200: Line 236:
|
|
|}
|}
Usage example: <code>PANEL_VFR_MAP_SHOW</code>


== FlowStateAction ==
== FlowStateAction ==

Revision as of 17:32, 8 January 2022


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.

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

Flow states

List of FlowStates

FlowStateName
INTRO
OUTRO
FREEFLIGHT
BUSHTRIP
LANDINGCHALLENGE
REPLAY
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

General
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_NAVLOG
LAUNCH_REPLAY Used to start replay by the user.
START_REPLAY Used to start replay for plane movement in the intro's of landing challenges.
STOP_WATCH_STARTED
STOP_WATCH_RESETED
ENTER_CURSOR_MODE
EXIT_CURSOR_MODE
BUSHTRIP_LEG_COMPLETED
ASK_CONTINUE_TO_FREE_FLIGHT
AI_SET_LANDING_STATE Force landing state.
UNACTIVATE_PUSHBACK
UI
SHOW_HUD
HIDE_HUD
Briefing
SHOW_MISSION_STARTUP Show briefing at the beginning of the flight.
HIDE_MISSION_STARTUP End the briefing. Used to stop the briefing before the replay has ended.
END_BRIEFING
Loading
SHOW_LOADING Show the loading screen.
HIDE_LOADING Hide the loading screen.
Pause
SHOW_PAUSEMENU Show the pause menu.
HIDE_PAUSEMENU Hide the pause menu.
RESUMEFROMPAUSE Resume the game.
Racing
RENO_MENU_SHOW
START_RENO_RACE_INGAME_DIALOG
SHOW_RENO_RTC_HUD
HIDE_RENO_RTC_HUD

You can also control the toolbar panels with flowevents. You need to combine the panel id with one of the modifiers like this: PANEL_VFR_MAP_SHOW

Modifiers
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.
Panel id's
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

FlowStateAction

FlowStateAction

FlowState action.

FirstState If true, the state is the first state in the gameflight's flow.
FromSpawn True if the state starts when the plane is spawned (during loading).
StayInStateAfter EndTeleportActions Stay in the current state after end of teleport.
FlowStateName Name of the flowstate.
ATCAircraft StateName Probably refers to the AcState in the [ATC_Aircraft.0] section of the flight definition file (.FLT).
TrafficAircraft StateName Probably refers to the AI state. Use: STATE_AIStateName
(e.g STATE_ENROUTE_AS_FILED).
AvailableIn TimeLine
IsFirstStateIn Timeline
NextState Link to the next FlowStateAction.
PauseOnStart
AutoStateSwitch Enabled


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).
Retrieved from ‘http://www.fsdeveloper.com/wiki/index.php?title=MSFS_Mission_Script_-_Flow_states&oldid=11280’