MSFS SDK Documentation Logo
Flighting
  • SDK Documentation

FsFlowEvent

The FsFlowEvent enum is used to specify the type of module / gauge to broadcast a flow event call to. An FsFlowEvent enum might be associated with an FLT file and, if so, that means that an FLT file has been loaded, which in turn means that SimVars must be used to re-initialized local variables because the context of the simulation has been changed.

 

Syntax
enum FsFlowEvent : unsigned short
{
    FsFlowEvent_None,
    FsFlowEvent_FltLoad,
    FsFlowEvent_FltLoaded,
    FsFlowEvent_TeleportStart,
    FsFlowEvent_TeleportDone,
    FsFlowEvent_BackOnTrackStart,
    FsFlowEvent_BackOnTrackDone,
    FsFlowEvent_SkipStart,
    FsFlowEvent_SkipDone,
    FsFlowEvent_BackToMainMenu,
    FsFlowEvent_RTCStart,
    FsFlowEvent_RTCEnd,
    FsFlowEvent_ReplayStart,
    FsFlowEvent_ReplayEnd,
    FsFlowEvent_FlightStart,
    FsFlowEvent_FlightEnd,
    FsFlowEvent_PlaneCrash,
};

 

Members
Enum MemberDescription
FsFlowEvent_NoneShould never be received.
FsFlowEvent_FltLoadGeneric event that indicates that a FLT file is being loaded.
FsFlowEvent_FltLoadedGeneric event indicating that a FLT file has been loaded, meaning the aircraft is now in a new state and that some internal variables should be re-initialized using the ones from the simulation.
FsFlowEvent_TeleportStartGeneric event that indicates when a teleport action is being executed. During a teleportation, some systems, physics, etc… might need to be paused to avoid weird behavior.
FsFlowEvent_TeleportDoneGeneric event that indicates when a teleport action has been executed.
FsFlowEvent_BackOnTrackStartEvent indicating that a back on track will be executed. As with SimObject teleportation, some systems might need to be paused.
FsFlowEvent_BackOnTrackDoneEvent indicating that a back on track has been executed.
FsFlowEvent_SkipStartEvent indicating that a part of an activity will be skipped (for example in career mode, the taxi part can be skipped to start the flight on the runway, which will load the corresponding FLT).
FsFlowEvent_SkipDoneEvent indicating that a part of an activity has been skipped.
FsFlowEvent_BackOnMainMenuEvent indicating that the simulation is going back to the menu.
FsFlowEvent_RTCStartEvent indicating that a RTC has started. As with SimObject teleportation, some systems might need to be paused.
FsFlowEvent_RTCEndEvent indicating that a RTC has ended.
FsFlowEvent_ReplayStartEvent indicating that a replay has started. As with SimObject teleportation, some systems might need to be paused.
FsFlowEvent_ReplayEndEvent indicating that a replay has ended.
FsFlowEvent_FlightStartEvent indicating that a flight has started.
FsFlowEvent_FlightEndEvent indicating that a flight has ended.
FsFlowEvent_PlaneCrashEvent indicating that an aircraft has crashed.

 

Remarks

N/A

 

Prev
Flow API
Next
fsFlowRegister