MSFS SDK Documentation Logo
Retail
  • SDK Documentation

SIMCONNECT_SIMOBJECT_TYPE

The SIMCONNECT_SIMOBJECT_TYPE enumeration type is used with the SimConnect_RequestDataOnSimObjectType call to request information on specific or nearby objects.

Syntax
enum SIMCONNECT_SIMOBJECT_TYPE{
    SIMCONNECT_SIMOBJECT_TYPE_USER = 0,
   SIMCONNECT_SIMOBJECT_TYPE_USER_AIRCRAFT = 0,
  SIMCONNECT_SIMOBJECT_TYPE_ALL,
  SIMCONNECT_SIMOBJECT_TYPE_AIRCRAFT,
  SIMCONNECT_SIMOBJECT_TYPE_HELICOPTER,
  SIMCONNECT_SIMOBJECT_TYPE_BOAT,
  SIMCONNECT_SIMOBJECT_TYPE_GROUND,
  SIMCONNECT_SIMOBJECT_TYPE_HOT_AIR_BALLOON,
  SIMCONNECT_SIMOBJECT_TYPE_ANIMAL,
  SIMCONNECT_SIMOBJECT_TYPE_USER_AVATAR,
  SIMCONNECT_SIMOBJECT_TYPE_USER_CURRENT,
    };
Members
MemberDescription
SIMCONNECT_SIMOBJECT_TYPE_USERSpecifies the user aircraft (this is a legacy value, as its naming is ambiguous as to whether the user is the avatar or the aircraft).
SIMCONNECT_SIMOBJECT_TYPE_USER_AIRCRAFTSpecifies the user aircraft.
SIMCONNECT_SIMOBJECT_TYPE_ALLSpecifies all AI controlled objects.
SIMCONNECT_SIMOBJECT_TYPE_AIRCRAFTSpecifies all aircraft.
SIMCONNECT_SIMOBJECT_TYPE_HELICOPTERSpecifies all helicopters.
SIMCONNECT_SIMOBJECT_TYPE_BOATSpecifies all AI controlled boats.
SIMCONNECT_SIMOBJECT_TYPE_GROUNDSpecifies all AI controlled ground vehicles.
SIMCONNECT_SIMOBJECT_TYPE_HOT_AIR_BALLOONSpecifies all hot air balloons.
SIMCONNECT_SIMOBJECT_TYPE_ANIMALSpecifies all animals.
SIMCONNECT_SIMOBJECT_TYPE_USER_AVATARSpecifies the user avatar.
SIMCONNECT_SIMOBJECT_TYPE_USER_CURRENTSpecifies the user, regardless of whether it is the aircraft or avatar.
Remarks

This enum is used to specify the return of the object IDs of all objects created using the AI creation functions, whether they are created by this client, other clients, or Microsoft Flight Simulator 2024 itself. It can also be used to specify the return the object ID of the user aircraft. However it cannot be used to specify the IDs of objects like cars moving on freeways, which are not controlled by the AI component.

See the remarks and examples for SimConnect_AddToDataDefinition.

Prev
SIMCONNECT_RECV
Next
SIMCONNECT_STATE

0/255