Overview
This section lists all the API functions, structures, enumerations, and other coding information necessary to build SimConnect clients.
Information on each API call includes some example code. This code does not form a complete program in any sense, but simply highlights the uses of the API call.
Functions
General Functions
Lifecycle Specific Function Name | Description |
---|---|
SimConnect_Open | Used to send a request to the Prepar3D server to open up communications with a new client. |
SimConnect_Close | Used to request that the communication with the server is ended. |
DispatchProc* | *Written by the developer of the SimConnect client, as a callback function to handle all the communications with the server. |
SimConnect_CallDispatch | Used to process the next SimConnect message received through the specified callback function. |
SimConnect_GetNextDispatch | Used to process the next SimConnect message received, without the use of a callback function. | Client Event Specific Function Name | Description |
SimConnect_AddClientEventToNotificationGroup | Used to add an individual client defined event to a notification group. |
SimConnect_MapClientEventToSimEvent | Used to associate a client defined event ID with an Prepar3D event name. |
SimConnect_MapInputEventToClientEvent | Used to connect input events (such as keystrokes, joystick or mouse movements) with the sending of appropriate event notifications. |
SimConnect_RemoveClientEvent | Used to remove a client defined event from a notification group. |
SimConnect_TransmitClientEvent | Used to request that the Prepar3D server transmit to all SimConnect clients the specified client event. This version of the function provides a 32-bit context data field. |
SimConnect_TransmitClientEvent64 | Used to request that the Prepar3D server transmit to all SimConnect clients the specified client event. This version of the function provides a 64-bit context data field. | Client Data Specific Function Name | Description |
SimConnect_AddToClientDataDefinition | Used to add an offset and a size in bytes, or a type, to a client data definition. |
SimConnect_CreateClientData | Used to request the creation of a reserved data area for this client. |
SimConnect_MapClientDataNameToID | Used to associate an ID with a named client date area. |
SimConnect_RequestClientData | Used to request that the data in an area created by another client be sent to this client. |
SimConnect_SetClientData | Used to write one or more units of data to a client data area. |
SimConnect_ClearClientDataDefinition | Used to clear the definition of the specified client data. | Notification Group Specific Function Name | Description |
SimConnect_AddClientEventToNotificationGroup | Used to add an individual client defined event to a notification group. |
SimConnect_ClearNotificationGroup | Used to remove all the client defined events from a notification group. |
SimConnect_RequestNotificationGroup | Used to request events are transmitted from a notification group, when the simulation is in Dialog Mode. |
SimConnect_SetNotificationGroupPriority | Used to set the priority of a notification group. | Input Event Specific Function Name | Description |
SimConnect_MapInputEventToClientEvent | Used to connect input events (such as keystrokes, joystick or mouse movements) with the sending of appropriate event notifications. |
SimConnect_RemoveInputEvent | Used to remove an input event from a specified input group object. |
SimConnect_RequestJoystickDeviceInfo | Used to request the name and number of currently connected joystick devices. |
SimConnect_RequestReservedKey | Used to request a specific keyboard TAB-key combination applies only to this client. | Input Group Specific Function Name | Description |
SimConnect_ClearInputGroup | Used to remove all the input events from a specified input group object. |
SimConnect_SetInputGroupPriority | Used to set the priority for a specified input group object. |
SimConnect_SetInputGroupState | Used to turn requests for input event information from the server on and off. | System Event Function Name | Description |
SimConnect_SetSystemEventState | Used to turn requests for event information from the server on and off. |
SimConnect_SubscribeToSystemEvent | Used to request that a specific system event is notified to the client. |
SimConnect_SubscribeToSystemEventEx | Used to request that a specific system event is notified to the client. Flags allow you to request a blocking callback. |
SimConnect_SubscribeToSystemEventW | Used to request that a specific system event is notified to the client. Flags allow you to request a blocking callback. This version of the function supports unicode string results. |
SimConnect_UnsubscribeFromSystemEvent | Used to request that notifications are no longer received for the specified system event. | System Event Function Name | Description |
SimConnect_SetSystemState | Used to access a number of Prepar3D system components. |
SimConnect_RequestSystemState | Used to request information from a number of Prepar3D system components. |
SimConnect_RequestSystemStateW | Used to request information from a number of Prepar3D system components. | Data Definition Specifc Function Name | Description |
SimConnect_AddToDataDefinition | Used to add a Prepar3D simulation variable name to a client defined object definition. |
SimConnect_ClearDataDefinition | Used to remove all simulation variables from a client defined object. | Misc Function Name | Description |
SimConnect_GetLastSentPacketID | Returns the ID of the last packet sent to the SimConnect server. |
SimConnect_RequestSessionDuration | Used to request the duration of the current scenario in seconds. |
SimConnect_RequestVersion | Used to request license type and version numbers of P3D and SimConnect. |
SimConnect_RequestResponseTimes | Used to provide some data on the performance of the client-server connection | String Specific Function Name | Description |
SimConnect_InsertString | Used to assist in adding variable length narrow strings to a structure. |
SimConnect_InsertStringW | Used to assist in adding variable length wide strings to a structure. |
SimConnect_RetrieveString | Used to assist in retrieving variable length narrow strings from a structure. |
SimConnect_RetrieveStringW | Used to assist in retrieving variable length wide strings from a structure. | Synchronous SimConnect Specific Function Name - Overview | Description |
SimConnect_RequestSynchronousBlock | Used to request a blocking callback. |
SimConnect_SynchronousUnblock | Used to release a blocking callback. |
SimConnect_SetSynchronousTimeout | Used to set the error timeout length for blocking callbacks. |
SimConnect_SubscribeToSystemEventEx | Used to request that a specific system event is notified to the client. Flags allow you to request a blocking callback. | Menu Specific Function Name | Description |
SimConnect_MenuAddItem | Used to add a menu item, associated with a client event. This version of the function provides a 32-bit context data field. |
SimConnect_MenuAddItem64 | Used to add a menu item, associated with a client event. This version of the function provides a 64-bit context data field. |
SimConnect_MenuAddSubItem | Used to add a sub-menu item, associated with a client event. This version of the function provides a 32-bit context data field. |
SimConnect_MenuAddSubItem64 | Used to add a sub-menu item, associated with a client event. This version of the function provides a 64-bit context data field. |
SimConnect_MenuDeleteItem | Used to remove a client defined menu item. |
SimConnect_MenuDeleteSubItem | Used to remove a specified sub-menu item. |
SimConnect_Text | Used to display a text menu, message window, or scrolling or static text, on the screen. |
SimObject Functions
General SimObject Function Name | Description |
---|---|
SimConnect_SetDataOnSimObject | Used to make changes to the data properties of an object. |
SimConnect_ChangeVehicle | Used to change the user's vehicle. |
SimConnect_RequestAttachPointData | Used to request attach point positions and orientations from a simulation object. |
SimConnect_RequestDataOnSimObject | Used to request when the SimConnect client is to receive data values for a specific object. |
SimConnect_RequestDataOnSimObjectType | Used to retrieve information about simulation objects of a given type that are within a specified radius of the user's vehicle. | AI Object Specific Function Name | Description |
SimConnect_AICreateEnrouteATCAircraft | Used to create an AI controlled aircraft that is about to start or is already underway on its flight plan. |
SimConnect_AICreateEnrouteATCAircraftW | Used to create an AI controlled aircraft that is about to start or is already underway on its flight plan. This version of the functions supports unicode file paths, titles, tail numbers, and flight plans. |
SimConnect_AICreateNonATCAircraft | Used to create an aircraft that is not flying under ATC control (so is typically flying under VFR rules). |
SimConnect_AICreateParkedATCAircraft | Used to create an AI controlled aircraft that is currently parked and does not have a flight plan. |
SimConnect_AICreateSimulatedObject | Used to create AI controlled objects other than aircraft. |
SimConnect_AICreateSimulatedObjectEx | Used to create AI controlled objects other than aircraft. Extended for use with disabled simulations and Owned objects |
SimConnect_AICreateObjectWithExternalSim | Used to create an AI object, overriding the sim to use a specific External Sim instead. |
SimConnect_AIReleaseControl | Used to clear the AI control of a simulated object, typically an aircraft, in order for it to be controlled by a SimConnect client. |
SimConnect_AIReleaseControlEx | Used to clear the AI control of a simulated object, typically an aircraft, in order for it to be controlled by a SimConnect client. Extended to be able to remove the AI entirely. |
SimConnect_AIRemoveObject | Used to remove any object created by the client using one of the SimConnect AI creation functions. |
SimConnect_AISetAircraftFlightPlan | Used to set or change the flight plan of an AI controlled aircraft. |
SimConnect_AISetAircraftFlightPlanW | Used to set or change the flight plan of an AI controlled aircraft. This version of the function supports unicode file paths. |
SimConnect_AISetGroundClamp | Used to enable/disable ground clamping on a specific SimConnect owned SimObject. | Attach Sim Specific Function Name - Overview | Description |
SimConnect_AttachObjectToSimObject | Used to create a SimObject and attach it to an existing SimObject. |
SimConnect_AttachSimObjectToSimObject | Used to attach an existing SimObject to another existing SimObject. |
SimConnect_ReleaseSimObjectFromSimObject | Used to release a SimObject from another SimObject. | Attach Weapon Specific Function Name - Overview | Description |
SimConnect_AttachWeaponToObject | Used to create a Weapon and attach it to an existing SimObject. |
SimConnect_ClearWeapons | Used to remove all Weapons from a SimObject. | External Sim Specific Function Name - Overview | Description |
SimConnect_RegisterExternalSim | Used to register this client as an external sim provider. |
SimConnect_UnregisterExternalSim | Used to unregister this client as an external sim provider. |
SimConnect_RegisterExternalSecondarySim | Used to register this client as an external secondary sim provider. |
SimConnect_UnregisterExternalSecondarySim | Used to unregister this client as an external secondarysim provider. |
SimConnect_AttachExternalSecondarySimToSimObject | Used to attach an External Secondary Sim to an existing SimObject. |
SimConnect_DetachExternalSecondarySimFromSimObject | Used to detach an External Secondary Sim from an existing SimObject. |
SimConnect_AICreateObjectWithExternalSim | Used to create an AI object, overriding the sim to use a specific External Sim instead. |
SimConnect_ChangeVehicleWithExternalSim | Used to change the user's vehicle and override the sim to use a specific External Sim instead. |
View Functions
View Specific Function Name | Description |
---|---|
SimConnect_ChangeView | Used to change the camera used by the main view. |
SimConnect_OpenView | Used to open a new view. |
SimConnect_CloseView | Used to close a view. |
SimConnect_DockView | Used to dock a view. |
SimConnect_UndockView | Used to undock a view. | Camera Post-Process Specific Function Name | Description |
SimConnect_AddPostProcess | Used to add a post process effect to the specified camera. |
SimConnect_AddPostProcessMainCamera | Used to add a post process effect to the main camera. |
SimConnect_RemovePostProcess | Used to remove a post process effect to the specified camera. |
SimConnect_RemovePostProcessMainCamera | Used to remove a post process effect to the main camera. | Camera Sensor Specific Function Name | Description |
SimConnect_RequestCameraSensorMode | Used to request the current sensor mode of a given view. |
SimConnect_RequestMainCameraSensorMode | Used to request the current sensor mode of the main view. |
SimConnect_SetCameraSensorMode | Used to change the sensor mode of a camera. |
SimConnect_SetMainCameraSensorMode | Used to change the sensor mode of the main camera. | Camera Specific Function Name | Description |
SimConnect_CameraPanToView | Used to smoothly transition the view of the specified camera to the view of the specified target camera. This function currently only works for Custom Cameras. |
SimConnect_CameraSetRelative6DOF | Used to adjust the user's aircraft view camera. |
SimConnect_CameraSetRelative6DofByName | Used to adjust the specified view's camera. |
SimConnect_CameraSmoothRelative6DOF | Used to smoothly transition the view of the main camera to the specified location. |
SimConnect_CameraSmoothRelative6DOFByName | Used to smoothly transition the view of the specified camera to the specified location. |
SimConnect_CameraZoomIn | Used to adjust the zoom of the camera. |
SimConnect_CameraZoomOut | Used to adjust the zoom of the camera. |
SimConnect_CreateCameraDefinition | Used to create a new camera definition. |
SimConnect_CreateCameraInstance | Used to create a new camera instance from a camera definition. |
SimConnect_DeleteCameraInstance | Used to remove a camera instance from a camera definition. |
SimConnect_MainCameraPanToView | Used to smoothly transition the view of the main camera to the view of the specified target camera. This function currently only works for Custom Cameras. |
SimConnect_MainCameraZoomIn | Used to adjust the zoom of the main camera. |
SimConnect_MainCameraZoomOut | Used to adjust the zoom of the main camera. |
SimConnect_RequestCameraFov | Used to request the field-of-view of a given view (horizontal and vertical). See SIMCONNECT_RECV_CAMERA_FOV. |
SimConnect_RequestCameraRelative6DOF | Used to request the XYZ delta offset from the eyepoint reference point, as well as the pitch, bank, and heading of the main view. |
SimConnect_RequestCameraRelative6DofByName | Used to request the XYZ delta offset from the eyepoint reference point, as well as the pitch, bank, and heading of a given view. |
SimConnect_RequestCameraWindowPosition | Used to request the current window position of a given view. |
SimConnect_RequestCameraWindowSize | Used to request the current window size of a given view. |
SimConnect_RequestMainCameraFov | Used to request the field-of-view of the main view (horizontal and vertical). See SIMCONNECT_RECV_CAMERA_FOV. |
SimConnect_SendCameraCommand | Used to simulate user inputs to control camera movement and rotation. |
SimConnect_SetCameraFov | Used to change the FoV (Field of View) of a camera. |
SimConnect_SetCameraHorizontalFov | Used to change the horizontal FoV (Field of View) of a camera. |
SimConnect_SetCameraVerticalFov | Used to change the vertical FoV (Field of View) of a camera. |
SimConnect_SetCameraWindowPosition | Used to set the window position of the specified view. |
SimConnect_SetCameraWindowSize | Used to set the window size of the specified view. |
SimConnect_SetMainCameraFov | Used to change the FoV (Field of View) of the main camera. |
SimConnect_SetMainCameraHorizontalFov | Used to change the horizontal FoV (Field of View) of the main camera. |
SimConnect_SetMainCameraVerticalFov | Used to change the vertical FoV (Field of View) of the main camera. | Image and Video Capture Specific Function Name | Description |
SimConnect_CaptureImage | Used to capture an image of a view. |
SimConnect_CaptureImageW | Used to capture an image of a view. This version of the function supports unicode file paths, filenames, and view names. |
SimConnect_BeginVideoStream | Used to begin a video stream of a view. |
SimConnect_EndVideoStream | Used to end a video stream of a view. | Observer View Specific Function Name | Description |
SimConnect_CreateObserver | Used to create an observer view. |
SimConnect_RequestObserverData | Used to request all data for a specific observer. |
SimConnect_MoveObserver | Used to move an observer using an xyz translation. |
SimConnect_RotateObserver | Used to rotate an observer around a specified axis. |
SimConnect_SetObserverPosition | Used to place an observer at a specific world position. |
SimConnect_SetObserverRotation | Used to set an observer's specific rotation. |
SimConnect_SetObserverLookAt | Used to have an observer look at a world position. |
SimConnect_SetObserverLookAtEx | Used to have an observer look at a world position round world corrected. |
SimConnect_ObserverTrackLocationOn | Used to have an observer track a world position (round world corrected) using an above ground level altitude and accounting for changes in elevation. |
SimConnect_ObserverTrackLocationOff | Used to disable continuous tracking of the previously specified world position. |
SimConnect_SetObserverFieldOfView | Used to set an observer's field of view. |
SimConnect_SetObserverStepSize | Used to set an observer's linear and angular step size. |
SimConnect_SetObserverFocalLength | Used to set an observer's focal length (in meters). |
SimConnect_SetObserverFocusFixed | Used to switch an observer's focus between local and world. |
SimConnect_SetObserverRegime | Used to switch an observer's regime (terrestrial, tellurian, or ghost). |
SimConnect_SetObserverZoomLevels | Used to set an observer's zoom level. |
SimConnect_ObserverTrackEntityOn | Used to enable continuous tracking of the specified entity. |
SimConnect_ObserverTrackEntityOff | Used to disable continuous tracking of the previously specified entity. |
SimConnect_ObserverAttachToEntityOn | Used to attach an observer to the specified entity. |
SimConnect_ObserverAttachToEntityOff | Used to detach an observer from its attached entity. |
SimConnect_SetObserverSceneryOrigin | Used to switch an observer's scenery origin mode (target or self). | Deprecated Camera Function Name | Description |
SetCameraRenderSettings | Deprecated |
SetCameraColorizationMode | Deprecated |
World Functions
Setting Specific Function Name | Description |
---|---|
SimConnect_RequestShadowFlags | Used to request the current shadow flag settings. |
SimConnect_RequestTrafficSettings | Used to request the current traffic settings. |
SimConnect_SetTrafficSettings | Used to set the current traffic settings. |
SimConnect_RequestSceneryComplexity | Used to request the current scenery complexity setting. | Facility Data Function Name | Description |
SimConnect_RequestFacilitiesList | Used to request a list of all the facilities of a given type currently held in the facilities cache. |
SimConnect_SubscribeToFacilities | Used to request notifications when a facility of a certain type is added to the facilities cache. |
SimConnect_UnsubscribeToFacilities | Used to request that notifications of additions to the facilities cache are not longer sent. | Ground Info Specific Function Name - Overview | Description |
SimConnect_RequestGroundInfo | Used to request a grid of ground altitudes at a specific lat/lon. |
SimConnect_RequestGroundInfoOnSimObject | Used to request a recurring grid of ground altitudes based on a SimObjects lat/lon. | Weather Specific Function Name | Description |
SimConnect_WeatherCreateStation | Used to add a weather station. |
SimConnect_WeatherCreateThermal | Used to create a thermal at a specific location. |
SimConnect_WeatherRemoveStation | Used to remove a weather station. |
SimConnect_WeatherRemoveThermal | Used to remove a thermal. |
SimConnect_WeatherRequestCloudState | Used to request cloud density information on a given area. |
SimConnect_WeatherRequestInterpolatedObservation | Used to send a request for weather data that is interpolated from the weather at the nearest weather stations. |
SimConnect_WeatherRequestObservationAtNearestStation | Used to send a request for the weather data from the weather station nearest to the specified lat/lon position. |
SimConnect_WeatherRequestObservationAtStation | Used to send a request for the weather data from a weather station identified by its ICAO code. |
SimConnect_WeatherSetDynamicUpdateRate | Used to set the rate at which cloud formations change. |
SimConnect_WeatherSetModeCustom | Used to set the weather mode to user-defined. |
SimConnect_WeatherSetModeGlobal | Used to set the weather mode to global, so the same weather data is used everywhere. |
SimConnect_WeatherSetModeServer | Deprecated. |
SimConnect_WeatherSetModeTheme | Used to set the weather mode to a particular theme. |
SimConnect_WeatherSetObservation | Used to set the weather at a specific weather station, identified from within the Metar data string | Effect Specific Function Name | Description |
SimConnect_CreateEffect | Used to create an effect at a location or attach it to an existing SimObject. |
SimConnect_RemoveEffect | Used to remove an effect. |
Scenario Functions
Scenario Functions | Description |
---|---|
SimConnect_FlightLoad | Used to load an existing scenario file. |
SimConnect_FlightLoadW | Used to load an existing scenario file. This version of the function supports unicode file paths. |
SimConnect_FlightPlanLoad | Used to load an existing flight plan. |
SimConnect_FlightPlanLoadW | Used to load an existing flight plan. This version of the function supports unicode file paths. |
SimConnect_FlightSave | Used to save the current state of a scenario to a scenario file. |
SimConnect_FlightSaveW | Used to save the current state of a scenario to a scenario file. This version of the function supports unicode file paths, titles, and descriptions. | Structured Scenario Specific Function Name | Description |
SimConnect_CompleteCustomMissionAction | Used to complete the scenario action specified by a GUID. |
SimConnect_ExecuteMissionAction | Used to execute the scenario action specified by a GUID. |
SimConnect_RequestFlightSegmentCount | Used to request the number of Flight Segment objects in the active scenario. |
SimConnect_RequestFlightSegmentDataByGUID | Used to request information about a Flight Segment object in the active scenario. |
SimConnect_RequestFlightSegmentDataByIndex | Used to request information about a Flight Segment object in the active scenario. |
SimConnect_RequestFlightSegmentRangeData | Used to request information about a specific range of a Flight Segment object in the active scenario. |
SimConnect_RequestGoalCount | Used to request the number of Goal/Group Goal objects in the active scenario. |
SimConnect_RequestGoalDataByGUID | Used to request information about a Goal/Group Goal object in the active scenario. |
SimConnect_RequestGoalDataByIndex | Used to request information about a Goal/Group Goal object in the active scenario. |
SimConnect_RequestMissionObjectiveCount | Used to request the number of Mission Objective objects in the active scenario. |
SimConnect_RequestMissionObjectiveDataByGUID | Used to request information about a Goal/Group Goal object in the active scenario. |
SimConnect_RequestMissionObjectiveDataByIndex | Used to request information about a Goal/Group Goal object in the active scenario. |
SimConnect_ResolveGoal | Used to resolve a goal to specified goal state. |
SimConnect_RequestChildGoalDataByIndex | Used to request information about a mission objective or group goal's children. |
SimConnect_RequestLandingTriggerCount | Used to request the number of Area Landing Trigger or Airport Landing Trigger objects in the active scenario. |
SimConnect_RequestLandingTriggerLandingInfoCount | Used to request information about a Landing Trigger object's landings in the active scenario. |
SimConnect_RequestLandingTriggerLandingInfoByIndex | Used to request information about a specific landing of a Landing Trigger object in the active scenario. |
SimConnect_RequestMobileSceneryInRadius | Used to retrieve mobile scenery objects that are within a specified radius of the user's vehicle. |
SimConnect_RequestMobileSceneryDataByID | Used to retrieve data about a specific mobile scenery object using its object ID. |
Analysis Functions
Flight Analysis Specific Function Name | Description |
---|---|
SimConnect_GenerateFlightAnalysisDiagrams | Used to generate diagrams as shown in the flight analysis UI which can be used, for example, to examine ILS landing performance. | Recorder Specific Function Name | Description |
SimConnect_PlaybackRecording | Used to playback a specified recording from a specified start time to a specified end time. |
SimConnect_PlaybackRecordingW | Used to playback a specified recording from a specified start time to a specified end time. This version of the function supports unicode file paths. |
SimConnect_StartRecorder | Used to trigger the Prepar3D Recorder to start recording. |
SimConnect_StopRecorderAndSaveRecording | Used to trigger the Prepar3D Recorder to stop recording and either prompt the user or save the recording with a specified file name. |
SimConnect_RequestRecordingInfo | Used to request information on a recording. |
SimConnect_RequestRecordingInfoW | Used to request information on a recording. This version of the function supports unicode file paths. |
SimConnect_RequestBookmarkInfo | Used to request bookmark information on a recording. |
SimConnect_RequestBookmarkInfoW | Used to request bookmark information on a recording. This version of the function supports unicode file paths. |
SimConnect Structures and Enumerations
SimConnect uses the following structures and enumerations.
Name | Structure or Enumeration | Description |
---|---|---|
SIMCONNECT_CLIENT_DATA_PERIOD | Enum | Used with the SimConnect_RequestClientData call to specify how often data is to be sent to the client. |
SIMCONNECT_DATA_RACE_RESULT | Struct | Used to hold multiplayer racing results. |
SIMCONNECT_DATATYPE | Enum | Used with the SimConnect_AddToDataDefinition call to specify the data type that the server should use to return the specified data to the client. |
SIMCONNECT_DATA_GROUND_INFO | Struct | Used to return info about one ground point entry in the array returned by a call to SimConnect_RequestGroundInfo or SimConnect_RequestGroundInfoOnSimObject |
SIMCONNECT_DATA_FACILITY_AIRPORT | Struct | Used to return information on a single airport in the facilities cache. |
SIMCONNECT_DATA_FACILITY_NDB | Struct | Used to return information on a single NDB station in the facilities cache. |
SIMCONNECT_DATA_FACILITY_VOR | Struct | Used to return information on a single VOR station in the facilities cache. |
SIMCONNECT_DATA_FACILITY_TACAN | Struct | Used to return information on a single TACAN station in the facilities cache. |
SIMCONNECT_DATA_FACILITY_WAYPOINT | Struct | Used to return information on a single waypoint in the facilities cache. |
SIMCONNECT_DATA_INITPOSITION | Struct | Used to initialize the position of a the user or AI controlled aircraft. |
SIMCONNECT_DATA_JOYSTICK_DEVICE_INFO | Struct | Used to return information about connected joystick devices by a call to SimConnect_RequestJoystickDeviceInfo |
SIMCONNECT_DATA_LATLONALT | Struct | Used to hold a world position. |
SIMCONNECT_DATA_MARKERSTATE | Struct | Used to help graphically link flight model data with the graphics model. |
SIMCONNECT_DATA_WAYPOINT | Struct | Used to hold all the necessary information on a waypoint. |
SIMCONNECT_DATA_XYZ | Struct | Used to hold a 3D co-ordinate. |
SIMCONNECT_DATA_PBH | Struct | Used to hold a rotation. |
SIMCONNECT_DATA_OBSERVER | Struct | Used to hold all data for a specific observer. |
SIMCONNECT_DATA_OBJECT_DAMAGED_BY_WEAPON | Struct | Used to hold all data for an object damaged by a weapon. |
SIMCONNECT_DATA_VIDEO_STREAM_INFO | Struct | Used to hold all data for a video stream. |
SIMCONNECT_EXCEPTION | Enum | Used with the SIMCONNECT_RECV_EXCEPTION structure to return information on an error that has occurred. |
SIMCONNECT_EXTERNAL_SIM_CALLBACK_FLAG | Enum | Used with the SimConnect_RegisterExternalSim and SimConnect_RegisterExternalSecondarySim functions to specify which External Sim Callbacks you wish to receive. |
SIMCONNECT_GOAL_RESOLUTION | Enum | Used by SimConnect_ResolveGoal to specify the state the specified goal should be resolved to. |
SIMCONNECT_GOAL_STATE | Enum | Used by SIMCONNECT_RECV_GOAL to specify the state of the the goal. |
SIMCONNECT_GROUND_INFO_LATLON_FORMAT | Enum | Used with the Simconnect_RequestGroundInfo and SimConnect_RequestGroundInfoOnSimObject functions to specify the format for latitude and longitude values. |
SIMCONNECT_GROUND_INFO_ALT_FORMAT | Enum | Used with the Simconnect_RequestGroundInfo and SimConnect_RequestGroundInfoOnSimObject functions to specify the format for altitude values. |
SIMCONNECT_GROUND_INFO_SOURCE_FLAG | Enum | Used with the Simconnect_RequestGroundInfo and SimConnect_RequestGroundInfoOnSimObject functions to specify types of ground you wish to receive. |
SIMCONNECT_FACILITY_LIST_TYPE | Enum | Used to determine which type of facilities data is being requested or returned. |
SIMCONNECT_LICENSE_TYPE | Enum | Used to determine which type of License is being run on the Application. |
SIMCONNECT_MISSION_END | Enum | Used to specify the three possible outcomes of a scenario. |
SIMCONNECT_MISSION_OBJECT_TYPE | Enum | Returned by SIMCONNECT_RECV_MISSION_OBJECT_COUNT struct to specify the type of scenario object. |
SIMCONNECT_MISSION_OBJECTIVE_STATUS | Enum | Used by SIMCONNECT_RECV_MISSION_OBJECTIVE to specify the state of the the mission objective. |
SIMCONNECT_PERIOD | Enum | Used with the SimConnect_RequestDataOnSimObject call to specify how often data is to be sent to the client. |
SIMCONNECT_RECV | Struct | Used with the SIMCONNECT_RECV_ID enumeration to indicate which type of structure has been returned. |
SIMCONNECT_RECV_AIRPORT_LIST | Struct | Used to return a list of SIMCONNECT_DATA_FACILITY_AIRPORT structures. |
SIMCONNECT_RECV_ASSIGNED_OBJECT_ID | Struct | Used to return an object ID that matches a request ID. |
SIMCONNECT_RECV_ATTACHPOINT_DATA | Struct | Will be received by the client after a successful call to SimConnect_RequestAttachPointData. |
SIMCONNECT_RECV_CAMERA_6DOF | Struct | Used to return the XYZ delta offset from the eyepoint reference point in meters as well as the pitch, bank, and heading of the camera. |
SIMCONNECT_RECV_CAMERA_FOV | Struct | Used to return the camera's current horizontal and vertical field of view.. |
SIMCONNECT_RECV_CAMERA_SENSOR_MODE | Struct | Used to return the camera's current sensor mode.. |
SIMCONNECT_RECV_CAMERA_WINDOW_POSITION | Struct | Used to return the camera's current window position. |
SIMCONNECT_RECV_CAMERA_WINDOW_SIZE | Struct | Used to return the camera's current window size. |
SIMCONNECT_RECV_CLIENT_DATA | Struct | Will be received by the client after a successful call to SimConnect_RequestClientData. The structure is identical to SIMCONNECT_RECV_SIMOBJECT_DATA. |
SIMCONNECT_RECV_CLOUD_STATE | Struct | Used to return an array of cloud state data. |
SIMCONNECT_RECV_CUSTOM_ACTION | Struct | Used specifically with the scenario system, providing details on the custom action that has been triggered. |
SIMCONNECT_RECV_EVENT | Struct | Used to return an event ID to the client. |
SIMCONNECT_RECV_EVENT_64 | Struct | Used to return an event ID along with 64-bit user context data to the client. |
SIMCONNECT_RECV_EVENT_FILENAME | Struct | Used with the SimConnect_SubscribeToSystemEvent to return a filename and an event ID to the client. |
SIMCONNECT_RECV_EVENT_FRAME | Struct | Used with the SimConnect_SubscribeToSystemEvent to return the frame rate and simulation speed to the client. |
SIMCONNECT_RECV_EVENT_MULTIPLAYER_CLIENT_STARTED | Struct | Sent to a client when they have successfully joined a multiplayer race. |
SIMCONNECT_RECV_EVENT_MULTIPLAYER_SERVER_STARTED | Struct | Sent to the host when the session is visible to other users in the lobby. |
SIMCONNECT_RECV_EVENT_MULTIPLAYER_SESSION_ENDED | Struct | Sent to a client when they have requested to leave a race, or to all players when the session is terminated by the host. |
SIMCONNECT_RECV_EVENT_OBJECT_ADDREMOVE | Struct | Used to return the type and ID of an AI object that has been added or removed from the simulation, by any client. |
SIMCONNECT_RECV_EVENT_RACE_END | Struct | Used to hold the results for one player at the end of a race. |
SIMCONNECT_RECV_EVENT_RACE_LAP | Struct | Used to hold the results for one player at the end of a lap. |
SIMCONNECT_RECV_EXCEPTION | Struct | Used with the SIMCONNECT_EXCEPTION enumeration type to return information on an error that has occurred. |
SIMCONNECT_RECV_EXTERNAL_SIM_BASE | Struct | Base class for External Sim callback data. |
SIMCONNECT_RECV_EXTERNAL_SIM_CREATE | Struct | Used with the External Sim Create Callback. |
SIMCONNECT_RECV_EXTERNAL_SIM_DESTROY | Struct | Used with the External Sim Destroy Callback. |
SIMCONNECT_RECV_EXTERNAL_SIM_SIMULATE | Struct | Used with the External Sim Simulate Callback. |
SIMCONNECT_RECV_EXTERNAL_SIM_LOCATION_CHANGED | Struct | Used with the External Sim Location Changed Callback. |
SIMCONNECT_RECV_EXTERNAL_SIM_EVENT | Struct | Used with the External Sim Event Callback. |
SIMCONNECT_RECV_EVENT_WEAPON | Struct | Used to send a notification of a detachable weapon being fired or detonated. |
SIMCONNECT_RECV_EVENT_COUNTERMEASURE | Struct | Used to send a notification of a deployed countermeasure. |
SIMCONNECT_RECV_EVENT_OBJECT_DAMAGED_BY_WEAPON | Struct | Used to send a notification of an object being damaged by a weapon. |
SIMCONNECT_RECV_FACILITIES_LIST | Struct | Used to provide information on the number of elements in a list of facilities returned to the client, and the number of packets that were used to transmit the data. |
SIMCONNECT_RECV_FLIGHT_SEGMENT | Struct | Received by the client after a successful call to SimConnect_RequestFlightSegmentDataByGUID or SimConnect_RequestFlightSegmentDataByIndex. |
SIMCONNECT_RECV_FLIGHT_SEGMENT_READY_FOR_GRADING | Struct | Received by the client with a FlightSegmentReadyForGrading notification. Contains instance ID of the Flight Segment. |
SIMCONNECT_RECV_GOAL | Struct | Received by the client after a successful call to SimConnect_RequestGoalDataByGUID or SimConnect_RequestGoalDataByIndex. |
SIMCONNECT_RECV_GOAL_PAIR | Struct | Received by the client after a successful call to SimConnect_RequestChildGoalDataByIndex. |
SIMCONNECT_RECV_MISSION_OBJECT_COUNT | Struct | Received by the client after a successful call to SimConnect_RequestFlightSegmentCount, SimConnect_RequestGoalCount, SimConnect_RequestMissionObjectiveCount, or SimConnect_RequestLandingTriggerCount. |
SIMCONNECT_RECV_MISSION_OBJECTIVE | Struct | Received by the client after a successful call to SimConnect_RequestMissionObjectiveDataByGUID or SimConnect_RequestMissionObjectiveDataByIndex. |
SIMCONNECT_RECV_PARAMETER_RANGE | Struct | Received by the client after a successful call to SimConnect_RequestFlightSegmentRangeData. |
SIMCONNECT_RECV_PLAYBACK_STATE_CHANGED | Struct | Received by the client with a PlaybackStateChanged notification. Contains whether playback has started or ended and the file name of the recording. |
SIMCONNECT_RECV_RECORDER_STATE_CHANGED | Struct | Received by the client with a RecorderStateChanged notification. Contains whether recording has started or ended.. |
SIMCONNECT_RECV_RECORDING_INFO | Struct | Received by the client after a successful call to SimConnect_RequestRecordingInfo |
SIMCONNECT_RECV_RECORDING_BOOKMARK_INFO | Struct | Received by the client after a successful call to SimConnect_RequestBookmarkInfo |
SIMCONNECT_RECV_LANDING_TRIGGER_INFO | Struct | Received by the client after a successful call to SimConnect_RequestLandingTriggerLandingInfoCount |
SIMCONNECT_RECV_LANDING_INFO | Struct | Received by the client after a successful call to SimConnect_RequestLandingTriggerLandingInfoByIndex |
SIMCONNECT_RECV_GROUND_INFO | Struct | Used with the SimConnect_RequestGroundInfo and SimConnect_RequestGroundInfoOnSimObject functions. |
SIMCONNECT_RECV_JOYSTICK_DEVICE_INFO | Struct | Received by the client after a successful call to SimConnect_RequestJoystickDeviceInfo |
SIMCONNECT_RECV_MOBILE_SCENERY_IN_RADIUS | Struct | Received by the client after a successful call to SimConnect_RequestMobileSceneryInRadius |
SIMCONNECT_RECV_MOBILE_SCENERY_DATA | Struct | Received by the client after a successful call to SimConnect_RequestMobileSceneryDataByID |
SIMCONNECT_RECV_ID | Enum | Used within the SIMCONNECT_RECV structure to indicate which type of structure has been returned. |
SIMCONNECT_RECV_NDB_LIST | Struct | Used to return a list of SIMCONNECT_DATA_FACILITY_NDB structures. |
SIMCONNECT_RECV_OPEN | Struct | Used to return information to the client, after a successful call to SimConnect_Open. |
SIMCONNECT_RECV_QUIT | Struct | This is an identical structure to the SIMCONNECT_RECV structure. |
SIMCONNECT_RECV_RESERVED_KEY | Struct | Used with the SimConnect_RequestReservedKey function to return the reserved key combination. |
SIMCONNECT_RECV_SCENERY_COMPLEXITY | Struct | Will be received by the client after a successful call to SimConnect_RequestSceneryComplexity. |
SIMCONNECT_RECV_SESSION_DURATION | Struct | Will be received by the client after a successful call to SimConnect_RequestSessionDuration. |
SIMCONNECT_RECV_SHADOW_FLAGS | Struct | Will be received by the client after a successful call to SimConnect_RequestShadowFlags. |
SIMCONNECT_RECV_SIMOBJECT_DATA | Struct | Will be received by the client after a successful call to SimConnect_RequestDataOnSimObject or SimConnect_RequestDataOnSimObjectType. |
SIMCONNECT_RECV_SIMOBJECT_DATA_BYTYPE | Struct | Will be received by the client after a successful call to SimConnect_RequestDataOnSimObjectType. The structure is identical to SIMCONNECT_RECV_SIMOBJECT_DATA. |
SIMCONNECT_RECV_SYNCHRONOUS_BLOCK | Struct | Well be received by the client in response to a call to SimConnect_RequestSynchronousBlock. |
SIMCONNECT_RECV_SYSTEM_STATE | Struct | Used with the SimConnect_RequestSystemState function to retrieve specific Prepar3D systems states and information. |
SIMCONNECT_RECV_TACAN_LIST | Struct | Used to return a list of SIMCONNECT_DATA_FACILITY_TACAN structures. |
SIMCONNECT_RECV_TRAFFIC_SETTINGS | Struct | Will be received by the client after a successful call to SimConnect_RequestTrafficSettings. |
SIMCONNECT_RECV_VOR_LIST | Struct | Used to return a list of SIMCONNECT_DATA_FACILITY_VOR structures. |
SIMCONNECT_RECV_WAYPOINT_LIST | Struct | Used to return a list of SIMCONNECT_DATA_FACILITY_WAYPOINT structures. |
SIMCONNECT_RECV_WEATHER_OBSERVATION | Struct | Used to return weather observation data after a call to SimConnect_WeatherRequestInterpolatedObservation, SimConnect_WeatherRequestObservationAtStation, or SimConnect_WeatherRequestObservationAtNearestStation. |
SIMCONNECT_RECV_OBSERVER_DATA | Struct | Will be received by the client after a successful call to SimConnect_RequestObserverData. |
SIMCONNECT_SIMOBJECT_TYPE | Enum | Used with the SimConnect_RequestDataOnSimObjectType call to request information on specific or nearby objects. |
SIMCONNECT_STATE | Enum | Used with the SimConnect_SetSystemEventState call to turn the reporting of events on and off. |
SIMCONNECT_TEXT_RESULT | Enum | Used to specify which event has occurred as a result of a call to SimConnect_Text. |
SIMCONNECT_TEXT_TYPE | Enum | Used to specify which type of text is to be displayed by the SimConnect_Text function |
SIMCONNECT_WAYPOINT_FLAGS | Enum | Used with the SIMCONNECT_DATA_WAYPOINT structure to define waypoints. |
SIMCONNECT_WEATHER_MODE | Enum | Used to return the current weather mode, after a call using the SIMCONNECT_RECV_ID_EVENT_WEATHER_MODE setting. |
SIMCONNECT_CAMERA_SENSOR_MODE | Enum | Used to specify a camera's sensor mode using the SimConnect_SetCameraSensorMode call. |
SIMCONNECT_CAMERA_TYPE | Enum | Used with the SimConnect_CreateCameraDefinition call to create a new camera definition. |
SIMCONNECT_CAMERA_COMMAND | Enum | Used with the SimConnect_SendCameraCommand call to move camera. |
SIMCONNECT_DYNAMIC_FREQUENCY | Enum | Used with the SimConnect_SetTrafficSettings function and the SIMCONNECT_RECV_TRAFFIC_SETTINGS struct. |
SIMCONNECT_SCENERY_COMPLEXITY | Enum | Used with the SimConnect_RequestSceneryComplexity function and the SIMCONNECT_RECV_SCENERY_COMPLEXITY struct. |