MSFS Mission Script - Flow states

From FSDeveloper Wiki
Jump to navigationJump to search


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
General
INTRO
OUTRO
BRIEFING
INTRO_PLANE
REPLAY
JOINPLANE
SPECTATOR
WAITING
TELEPORTTOSTATE
Flight stages
PREFLIGHT_GATE Used in Freeflight.
PREFLIGHT_PUSHBACK
PREFLIGHT_TAXI
PREFLIGHT_HOLDSHORT
FLIGHT_RUNWAY
FLIGHT_INITIAL_CLIMB
FLIGHT_CLIMB
FLIGHT_CRUISE
FLIGHT_DESCENT
LANDING_APPROACH
LANDING_FINAL
LANDING_TOUCHDOWN
LANDING_GROUNDROLL
LANDING_TAXI Used in Freeflight.
LANDING_GATE
LANDING_REST
Activities
FREEFLIGHT
BUSHTRIP
LANDINGCHALLENGE
Race
RACE_BASE
RACE_LOWALTITUDE
RACE_REDBULL
RACE_RENO
RACE_CRASHED_OR_DISQUALIFIED
RACE_LOBBY_BASE
RACE_LOBBY_REDBULL
RACE_WAIT
RACE_WAIT_PLAYERS_LOADING
RACE_WAIT_PLAYERS_FINISHED
RACE_WAIT_OPENING_RTC
RACE_WAIT_OPENING_RTC_EDITION
RACE_FINISH
QUALIFICATIONS_BASE
QUALIFICATIONS_RENO
QUALIFICATIONS_WAIT_OPENING_RTC
QUALIFICATIONS_WAIT_PLAYERS_FINISHED
QUALIFICATIONS_FINISH
RENO_MENU_INTRO
RENO_MENU_GAMEMODE
RENO_MENU_QUICK_BASE
RENO_MENU_QUICK_CATEGORY
RENO_MENU_QUICK_PLANE
RENO_MENU_QUICK_SEARCHMATCH
RENO_MENU_QUICK_WAITREADY
RENO_MENU_PRIVATE_BASE
RENO_MENU_PRIVATE_WAIT_SERVER
RENO_MENU_PRIVATE_CATEGORY
RENO_MENU_PRIVATE_PLANE
RENO_MENU_PRIVATE_WAITREADY
RENO_MENU_SOLO_BASE
RENO_MENU_SOLO_CATEGORY
RENO_MENU_SOLO_PLANE
RENO_MENU_SOLO_SETTINGS


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.
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
PanelId_FORCE_DISABLED Disable this panel. The user can't select it anymore.
PanelId_FORCE_ENABLED Allow the user to select this panel.
PanelId_SHOW Open the panel.
PanelId_FORCE_SHOW
PanelId_HIDE Hide the panel.
PanelId_TOGGLE
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).