Skip to content

XPC Client Reference

Jason Watkins edited this page Jun 2, 2015 · 10 revisions

Functions

The following functions are available on all clients except where otherwise noted. In particular, the openUDP and closeUDP functions will not appear in clients written for object-oriented languages. For those clients, openUDP is implicitly called when the object is created, closeUDP is implicitly called when the object is destroyed, and all necessary socket management is handled internally by the client object.

  • openUDP - Sets up a new connection to an X-Plane Connect plugin running in X-Plane.
  • closeUDP - Closes a connection to X-Plane Connect.
  • setCONN - Sets the port on which the client sends and receives data.
  • pauseSim - Pauses or unpauses the X-Plane physics simulation.
  • getDREF - Gets an X-Plane dataref.
  • getDREFs - Gets 1 or more X-Plane datarefs.
  • sendDREF - Sets the value of an X-Plane dataref.
  • readDATA - Reads data exported by X-Plane.
  • sendDATA - Sends raw data to X-Plane.
  • selectDATA - Sets which data rows X-Plane will export.
  • getCTRL - Gets controls surface information for a plane.
  • sendCTRL - Sets control surfaces for a plane.
  • getPOSI - Gets position and orientation of a plane.
  • sendPOSI - Sets position and orientation of a plane.
  • sendTEXT - Draws text on the screen.
  • sendVIEW - Sets the X-Plane camera.
  • sendWYPT - Draws waypoints in the world.