XPLMInitResult

Result codes from initializing or updating the user’s aircraft. Initialization can fail due to unparsable/invalid data, or due to the contents of the initialization containing parameters the sim cannot fulfill (e.g. an aircraft not on disk, a ramp start not present in an airport due to custom scenery).

If an initialization fails, a human-readable string is sent to your plugin’s error function. This is meant for debugging purposes only and should not be parsed. Your plugin’s logic should only use the result code for flow control.

NameValueDescription
xplm_Init_Success"0" The initialization succeeded.
xplm_Init_Invalid"1" The provided argument was invalid. This can be returned if the provided string is not a valid json string.
This error can also be returned if one or more of the provided arguments is invalid, such as a missing
required field or an unrecognized parameter such as an unknown runway name. Invalid errors imply that
your calling code is generating incorrect JSON and should be fixed; use your plugin's error callback
to find more detailed information about the problem with your input.
xplm_Init_MissingAircraft"2" The new flight could not be initialized because one of the aircraft requested could not be found
on disk or loaded.
xplm_Init_MissingLivery"3" The new flight could not be initialized because one of the aircraft's' requested liveries could
not be found on disk or loaded.
xplm_Init_MissingAirport"4" The new flight could not be initialized because the requested airport was not found in
X-Plane's airport database.
xplm_Init_MissingRamp"5" The new flight could not be initialized because the requested ramp start was not found at
the specified airport in X-Plane's airport database.
xplm_Init_MissingRunway"6" The new flight could not be initialized because the requested runway was not found at
the specified airport in X-Plane's airport database.