Crate xplane

Source
Expand description

Bindings to the X-Plane plugin SDK. These should be mostly safe, although care must be taken in some aspects. Any functions or modules that could behave in unexpected ways will try document that.

Panics should reliably unwind out into the simulator and produce a backtrace. The core will dump in a non-graceful manner, however, since X-Plane does not have an exception handler with the right personality for libunwind to grab at the bottom of the stack.

Modules§

avionics
Avionics
camera
Camera access.
command
Commands
data
Datarefs
error
Error detection
feature
SDK feature management
flight_loop
Flight loop callbacks
geometry
User interface geometry
menu
User interface menus
message
Plugin messages
navigation
Navigation APIs
obj_instance
[XPLMInstance] API wrappers. Locked behind XPLM303 due to bugs in earlier versions of X-Plane.
paths
Path conversion
player
Utility functions relating to the player.
plugin
Plugin creation and management
scenery
APIs to interact with X-Plane’s scenery system.
weather
Weather system
window
Relatively low-level windows

Macros§

debug
Writes a message to the developer console and Log.txt file. Keep output to the X-Plane log to a minimum. This file can get rather cluttered.
debugln
Writes a message to the developer console and Log.txt file, with a newline. Keep output to the X-Plane log to a minimum. This file can get rather cluttered.
xplane_plugin
Creates an X-Plane plugin

Structs§

XPAPI
Access struct for all APIs in this crate. Intentionally neither Send nor Sync. Almost nothing in this crate is.