SimConnect_AICreateNonATCAircraft

SimConnect_AICreateNonATCAircraft_EX1

The SimConnect_AICreateNonATCAircraft_EX1 function is used to create an aircraft that is not flying under ATC control (so is typically flying under VFR rules). This function can be used with both legacy SimObjects, and modular SimObjects.

Syntax

HRESULT SimConnect_AICreateNonATCAircraft_EX1(
    HANDLE  hSimConnect,
    const char*  szContainerTitle,
    const char* szLivery,
    const char*  szTailNumber,
    SIMCONNECT_DATA_INITPOSITION  InitPos,
    SIMCONNECT_DATA_REQUEST_ID  RequestID
    );

Parameters

Parameter	Description	Type
hSimConnect	Handle to a SimConnect object.	Integer
szContainerTitle	Null-terminated string containing the container title. The container title is found in the title parameter of the `aircraft.cfg` file, or alternatively, you can find it from the list found in the Aircraft Capture Tool. You may also retrieve the information with SimConnect using the `SimConnect_EnumerateSimObjectsAndLiveries` function. Examples of aircraft titles: `title=Boeing 747-8f Asobo` `title=DA62 Asobo` `title=VL3 Asobo`	String
szLivery	Null-terminated string containing the livery name. This field is only required when checking modular SimObjects, since their liveries are dynamically handled and do not have a unique title parameter like legacy aircraft. This parameter can be set to either the name of the livery as defined in the `name` parameter of the `livery.cfg`, or to the folder name of the livery in the package. Note that you can also get the livery name using the `SimConnect_EnumerateSimObjectsAndLiveries` function. The function will check for the folder first, then the parameter name second, and if the given name is not found in either location, then the default livery will be used.	String
szTailNumber	Null-terminated string containing the tail number. This should have a maximum of 12 characters.	String
InitPos	Specifies the initial position, using a `SIMCONNECT_DATA_INITPOSITION` structure.	Integer
RequestID	Specifies the client defined request ID.	String

Return Values

The function returns an HRESULT. Possible values include, but are not limited to, those in the following table.

Return value	Description
S_OK	The function succeeded.
E_FAIL	The function failed.

Remarks

A non-ATC aircraft can be on the ground or airborne when it is created by this function. The following exception can be caused by this function (refer to the SIMCONNECT_EXCEPTION enum for more details):

SIMCONNECT_EXCEPTION_CREATE_OBJECT_FAILED

Refer to the remarks for SimConnect_AICreateEnrouteATCAircraft_EA1.