xplra Namespace Reference

Python client module for the X-Plane Remote Access plugin. More...

Classes
class	DataRefTask
class	GetDataRefTask
class	GetScalarDataRefTask
class	GetIntDataRefTask
class	GetFloatDataRefTask
class	GetDoubleDataRefTask
class	GetArrayDataRefTask
class	GetFloatArrayDataRefTask
class	GetIntArrayDataRefTask
class	GetByteArrayDataRefTask
class	GetMultiDataRefRequest
class	Globals
class	HotkeyHandler
class	ListenThread
class	Menu
class	MessageRequest
class	MessageWindow
class	MultiTaskRequest
class	MultiTaskRequestTemplate
class	Protocol
class	ReloadPluginsRequest
class	Request
class	RequestQueue
class	SaveSituationRequest
class	ServerThread
class	SetDataRefTask
class	SetScalarDataRefTask
class	SetIntDataRefTask
class	SetFloatDataRefTask
class	SetDoubleDataRefTask
class	SetArrayDataRefTask
class	SetIntArrayDataRefTask
class	SetFloatArrayDataRefTask
class	SetByteArrayDataRefTask
class	SetMultiDataRefRequest
class	Task
class	TaskRequest
class	ProtocolException
class	Win32NamedPipe
class	XPlane
class	MultiBuffer
class	MultiGetter
class	MultiSetter

Variables
int	isPy3 = 3
int	COMMAND_GET_SINGLE = 0x01
	Protocol command: query the value of a single dataref.
int	COMMAND_SET_SINGLE = 0x02
	Protocol command: set the value of a single dataref.
int	COMMAND_GET_MULTI = 0x03
	Protocol command: query the value of several datarefs.
int	COMMAND_SET_MULTI = 0x04
	Protocol command: set the value of several datarefs.
int	COMMAND_REGISTER_GET_MULTI = 0x11
	Protocol command: register a multi-dataref getter.
int	COMMAND_UNREGISTER_GET_MULTI = 0x12
	Protocol command: unregister a multi-dataref getter.
int	COMMAND_EXECUTE_GET_MULTI = 0x13
	Protocol command: execute a registered multi-dataref getter.
int	COMMAND_REGISTER_SET_MULTI = 0x21
	Protocol command: register a multi-dataref setter.
int	COMMAND_UNREGISTER_SET_MULTI = 0x22
	Protocol command: unregister a multi-dataref setter.
int	COMMAND_EXECUTE_SET_MULTI = 0x23
	Protocol command: execute a registered multi-dataref setter.
int	COMMAND_GET_VERSIONS = 0x31
	Protocol command: get the versions of X-Plane, XPLM and XPLRA.
int	COMMAND_RELOAD_PLUGINS = 0x32
	Protocol command: reload all plugins.
int	COMMAND_SAVE_SITUATION = 0x33
	Protocol command: save the current situation into a file.
int	COMMAND_SHOW_MESSAGE = 0x41
	Protocol command: show a message to the pilot.
int	COMMAND_REGISTER_HOTKEYS = 0x51
	Protocol command: register hotkeys.
int	COMMAND_QUERY_HOTKEYS = 0x52
	Protocol command: query the status of registered hotkeys.
int	COMMAND_UNREGISTER_HOTKEYS = 0x53
	Protocol command: unregister hotkeys.
int	TYPE_INT = 0x01
	Protocol type constant: integer.
int	TYPE_FLOAT = 0x02
	Protocol type constant: single-precision floating point.
int	TYPE_DOUBLE = 0x03
	Protocol type constant: double-precision floating point.
int	TYPE_FLOAT_ARRAY = 0x11
	Protocol type constant: array of single-precision floating point values.
int	TYPE_INT_ARRAY = 0x12
	Protocol type constant: array of integers.
int	TYPE_BYTE_ARRAY = 0x13
	Protocol type constant: array of bytes.
int	RESULT_OK = 0x00
	Protocol result: OK.
int	RESULT_INVALID_COMMAND = 0x01
	Protocol result: an invalid command was sent.
int	RESULT_UNKNOWN_DATAREF = 0x02
	Protocol result: an unknown dataref was attempted to query or set.
int	RESULT_INVALID_TYPE = 0x03
	Protocol result: invalid type.
int	RESULT_INVALID_LENGTH = 0x04
	Protocol result: invalid length.
int	RESULT_INVALID_OFFSET = 0x05
	Protocol result: invalid offset.
int	RESULT_INVALID_COUNT = 0x06
	Protocol result: invalid count.
int	RESULT_INVALID_ID = 0x07
	Protocol result: invalid ID.
int	RESULT_INVALID_DURATION = 0x08
	Protocol result: invalid duration.
int	RESULT_OTHER_ERROR = 0xff
	Protocol result: other error.
int	HOTKEY_MODIFIER_SHIFT = 0x0100
	Hotkey modifier: Shift.
int	HOTKEY_MODIFIER_CONTROL = 0x0200
	Hotkey modifier: Control.
int	DEFAULT_TCP_PORT = 0x5852;
	The default TCP port ("XR")

Detailed Description

Python client module for the X-Plane Remote Access plugin.