Coherent.js
The Coherent.js file defines the Coherent class which has multiple functions designed to permit you to integrate C++ engine calls in your HTML/JS/CSS instruments within Microsoft Flight Simulator 2024 so that they can communicate with the simulation. The most important methods available to you from this file are as follows:
| Method | Description |
|---|---|
| RegisterViewListener(name, callback, requiresSingleton) | |
| on(name, callback, context) | |
| off(name, callback, context) | |
| trigger(name) | |
| call(name) |
RegisterViewListener(name, callback, requiresSingleton)
on(name, callback, context)
off(name, callback, context)
trigger(name)
call(name)
Listeners
When working with coherent calls you first need to use the RegisterViewListener() function to register the JS listener that you want to subscribe to. The listener will in turn define the calls that are available. There are a huge number of calls available across all the listeners and so we’ve created a page for each listener that is available and on each of the pages we list the available calls. You can also find a call index below the list of listener pages so you can quickly go straight to a specific call if you know it’s name.
JS_LISTENER_AIRCRAFT_SELECTION
JS_LISTENER_INGAMEPANEL_CONTROLS
JS_LISTENER_OPTIONS_ASSISTANCES
JS_LISTENER_OPTIONS_GENERALNEW
Events
The following is a list of the different events that may be triggered when working with the JavaScript API.
Call Index
This is a complete index of all calls available to you using coherent.call().
A
ACCEPT_MANDATORY_PACKAGES_UPDATE
ACTIVATE_DIRECT_TO_FROM_LATLONALT
AIRCRAFT_CROSSOVER_SPEED_FACTOR
AIRCRAFT_DESIGN_SPEED_BEST_GLIDE
AIRCRAFT_DESIGN_SPEED_MACH_MAX
AIRCRAFT_ELEVATOR_TRIM_NEUTRAL
AIRCRAFT_LOWEST_SELECTABLE_SPEED
AIRCRAFT_STALL_PROTECTION_SPEED_MAX
AIRCRAFT_STALL_PROTECTION_SPEED_MIN
AIRCRAFT_STALL_SPEED_PREDICTED
ASK_DELETE_CURRENT_GLOBAL_PROFILE
ASK_RENAME_CURRENT_GLOBAL_PROFILE
B
C
CHECK_LOGIN_STATE_ONLINE_CHANGED
CHECKLIST_DISPLAY_PREVIOUS_PAGE
CHECKLIST_FORCE_FINISH_COPILOT
CHECKLIST_GOTO_SELECT_CHECKLIST
CommunityPanelFriendActionData
CommunityPanelPlayerNotificationActionData
CommunityPanelPlayerNotificationData
CommunityPanelPlayerNotificationsData
CREATE_NEW_FLIGHTPLANS_UNTIL_INDEX
CreateOptionsMenuButtonWithTitle
D
E
F
FOCUS_INPUT_FIELD (JS_LISTENER_AIRPORT_SEARCH)
FOCUS_INPUT_FIELD (JS_LISTENER_FUEL_PAYLOAD)
FORCE_DISABLE_AND_HIDE_METAR_PANEL
G
Gamevar (JS_LISTENER_GAMEVARS)
GetGameFlight (JS_LISTENER_FLIGHT_BRIEFING)
GetGameFlight (JS_LISTENER_GAMEFLIGHT)
H
I
INGAME_PANEL_CONTROLS_ASK_DEVICE_LIST
inviteFriendToGroup (JS_LISTENER_COMMUNITY)
J
K
L
M
O
ON_AXIS_SENSITIVITY_MINUS_CHANGED
ON_AXIS_SENSITIVITY_PLUS_CHANGED
ON_BALLAST_TOTAL_PERCENT_CHANGED
ON_FUEL_TOTAL_QUANTITY_CHANGED
ON_INPUT_MAP_ON_RELEASE_CHANGED
ON_PAYLOAD_TOTAL_PERCENT_CHANGED
onCreateFriendRequestBySearchResultError
P
Q
R
RECOMPUTE_ACTIVE_WAYPOINT_INDEX
REMOVE_WAYPOINT_TRANSITION_LLAS
REPLAY_SET_FIRST_CAMERA_POSITION
REPLAY_SET_SECOND_CAMERA_POSITION
REPLAY_SET_SELECTED_TRACKSWITCH
REPLAY_START_RECORD_CAMERA_MISSION
REPLAY_START_RECORD_PLANE_MISSION
REPLAY_STOP_RECORD_CAMERA_MISSION
REPLAY_STOP_RECORD_PLANE_MISSION
replayObjectGetMissionKeyDataList
replayObjectGetMissionKeyValue
replayObjectGetMissionTimeline
replayObjectGetMissionTimelineData
REPLY_TO_AVIONICS_ROUTE_REQUEST
REQUEST_USER_INPUT_PROFILE_LIST
S
SET_ARRIVAL_ENROUTE_TRANSITION_INDEX
SET_DEPARTURE_ENROUTE_TRANSITION_INDEX
SET_FLIGHT_CONDITION_CONFIGURATION
SET_MAP_WEATHER_RADAR_BANK_LIMITS
SET_MAP_WEATHER_RADAR_PITCH_LIMITS
SET_MAP_WEATHER_RADAR_SCAN_RATE
SET_MAP_WEATHER_RADAR_STABILIZATION
SET_NEAREST_EXTENDED_AIRPORT_FILTERS
SET_NEAREST_INTERSECTION_FILTER
SET_SELECTED_FLIGHT_LEG (JS_LISTENER_FLIGHT_BRIEFING)
SET_SELECTED_FLIGHT_LEG (JS_LISTENER_GAMEFLIGHT)
SET_UI_SELECTED_WIND_LAYER_INDEX
T
U
V
VIEW_GAMERCARD_FROM_ID (JS_LISTENER_FLIGHT_BRIEFING)
VIEW_GAMERCARD_FROM_ID (JS_LISTENER_GAMEFLIGHT)
VIEW_GAMERCARD_FROM_PLAYFAB_ID (JS_LISTENER_COMMUNITY)
VIEW_GAMERCARD_FROM_PLAYFAB_ID (JS_LISTENER_FLIGHT_BRIEFING)
VIEW_GAMERCARD_FROM_PLAYFAB_ID (JS_LISTENER_GAMEFLIGHT)
W
WaitForRollingCachePopUpParams
WEATHER_VARIATION_SET_NEW_INDEX
WORLDMAP_AIRPORTINFOS_RUNWAY_ARRIVAL
WORLDMAP_AIRPORTINFOS_RUNWAY_DEPARTURE
WORLDMAP_SELECT_RUNWAY (JS_LISTENER_AIRPORT_INFOS)
WORLDMAP_SELECT_RUNWAY (JS_LISTENER_GAMEFLIGHT)
WORLDMAP_SELECT_RUNWAY (JS_LISTENER_WORLDMAP)
WORLDMAP_SELECT_WAYPOINT_INDEX
WORLDMAP_SELECT_WAYPOINT_INDEX (JS_LISTENER_WORLDMAP)