Changeset 86:f7714df5165f in xplra


Ignore:
Timestamp:
05/12/13 07:25:45 (11 years ago)
Author:
István Váradi <ivaradi@…>
Branch:
default
Phase:
public
Message:

Added the documentation of COMMAND_SAVE_SITUTATION

File:
1 edited

Legend:

Unmodified
Added
Removed
  • doc/overview.dox

    r71 r86  
    159159 * \ref command_get_versions "Query the versions of X-Plane, XPLM and XPLRA" | 0x31 | \anchor COMMAND_GET_VERSIONS COMMAND_GET_VERSIONS
    160160 * \ref command_reload_plugins "Reload the plugins in X-Plane" | 0x32 | \anchor COMMAND_RELOAD_PLUGINS COMMAND_RELOAD_PLUGINS
     161 * \ref command_save_situation "Save the current situation" | 0x33 | \anchor COMMAND_SAVE_SITUATION COMMAND_SAVE_SITUATION
    161162 * \ref command_show_message "Show a message in X-Plane's window" | 0x41 | \anchor COMMAND_SHOW_MESSAGE COMMAND_SHOW_MESSAGE
    162163 * \ref command_register_hotkeys "Register hotkeys to be listened to" | 0x51 | \anchor COMMAND_REGISTER_HOTKEYS COMMAND_REGISTER_HOTKEYS
     
    578579 * ---- | ------
    579580 * byte | 0x00 (\ref RESULT_OK)
     581 *
     582 * \subsection command_save_situation The SAVE_SITUATION command
     583 *
     584 * This command can be used to save the current situation into a file.
     585 * It is available only on X-Plane 10 or later.
     586 *
     587 * Type | Description
     588 * ---- | ------
     589 * byte | 0x33 (\ref COMMAND_SAVE_SITUATION)
     590 * string | the path of the file to save the situation into, relative to the X-Plane directory
     591 *
     592 * If successful, the reply is the following:
     593 *
     594 * Type | Description
     595 * ---- | ------
     596 * byte | 0x00 (\ref RESULT_OK)
     597 *
     598 * If an error was encountered, the reply is the following (no error could be produced yet,
     599 * but it might fail).
     600 *
     601 * Type | Description
     602 * ---- | ------
     603 * byte | 0xff (\ref RESULT_OTHER_ERROR)
    580604 *
    581605 * \subsection command_get_versions The GET_VERSIONS command
Note: See TracChangeset for help on using the changeset viewer.