MetzNet
/
dfhack
3
0
Fork 0
Code Issues Pull Requests Packages Projects Releases Wiki Activity

update docs for mousequery

develop
myk002 2022-07-28 03:22:32 -07:00
parent bcab483b57
commit f68b58c460
No known key found for this signature in database
GPG Key ID: 8A39CA0FA0C16E78
3 changed files with 51 additions and 40 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

35
docs/Tags.rst
Unescape Escape View File

@ -1,19 +1,20 @@
:orphan: :orphan:
- `tag/adventure`: Tools that are useful while in adventure mode - `tag/adventure`: Tools that are useful while in adventure mode.
- `tag/fort`: Tools that are useful while in fort mode - `tag/fort`: Tools that are useful while in fort mode.
- `tag/legends`: Tools that are useful while in legends mode - `tag/legends`: Tools that are useful while in legends mode.
- `tag/items`: Tools that create or modify in-game items - `tag/items`: Tools that create or modify in-game items.
- `tag/units`: Tools that create or modify units - `tag/units`: Tools that create or modify units.
- `tag/jobs`: Tools that create or modify jobs - `tag/jobs`: Tools that create or modify jobs.
- `tag/labors`: Tools that deal with labor assignment - `tag/labors`: Tools that deal with labor assignment.
- `tag/auto`: Tools that automatically manage some aspect of your fortress - `tag/auto`: Tools that automatically manage some aspect of your fortress.
- `tag/map`: Map modification - `tag/map`: Map modification.
- `tag/system`: Tools related to working with DFHack commands or the core DFHack library - `tag/system`: Tools related to working with DFHack commands or the core DFHack library.
- `tag/productivity`: Tools that help you do things that you could do manually, but using the tool is better and faster - `tag/productivity`: Tools that help you do things that you could do manually, but using the tool is better and faster.
- `tag/animals`: Tools that help you manage animals - `tag/animals`: Tools that help you manage animals.
- `tag/fix`: Tools that fix specific bugs - `tag/fix`: Tools that fix specific bugs.
- `tag/inspection`: Tools that let you inspect game data - `tag/inspection`: Tools that let you inspect game data.
- `tag/buildings`: Tools that help you work wtih placing or configuring buildings and furniture - `tag/buildings`: Tools that help you work wtih placing or configuring buildings and furniture.
- `tag/quickfort`: Tools that are involved in creating and playing back blueprints - `tag/quickfort`: Tools that are involved in creating and playing back blueprints.
- `tag/dev`: Tools useful for develpers and modders - `tag/dev`: Tools useful for develpers and modders.
- `tag/interface`: Tools that modify or extend the user interface.

40
docs/plugins/mousequery.rst
Unescape Escape View File

@ -1,16 +1,36 @@
mousequery mousequery
========== ==========
Adds mouse controls to the DF interface, e.g. click-and-drag designations. Tags: `tag/fort`, `tag/interface`
:dfhack-keybind:`mousequery`
Options: Adds mouse controls to the DF interface. For example, with ``mousequery`` you
can click on buildings to configure them, hold the mouse button to draw dig
:plugin: enable/disable the entire plugin designations, or click and drag to move the map around.
:rbutton: enable/disable right mouse button
:track: enable/disable moving cursor in build and designation mode
:edge: enable/disable active edge scrolling (when on, will also enable tracking)
:live: enable/disable query view when unpaused
:delay: Set delay when edge scrolling in tracking mode. Omit amount to display current setting.
Usage:: Usage::
mousequery [plugin] [rbutton] [track] [edge] [live] [enable|disable] enable mousequery
mousequery [rbutton|track|edge|live] [enable|disable]
mousequery drag [left|right|disable]
mousequery delay [<ms>]
:rbutton: When the right mouse button is clicked, cancel out of menus or
scroll the main map if you r-click near an edge.
:track: Move the cursor with the mouse instead of the cursor keys when you
are in build or designation modes.
:edge: Scroll the map when you move the cursor to a map edge. See ``delay``
below. If enabled also enables ``track``.
:delay: Set delay in milliseconds for map edge scrolling. Omit the amount to
display the current setting.
:live: Display information in the lower right corner of the screen about
the items/building/tile under the cursor, even while unpaused.
Examples
--------
``mousequery rbutton enable``
Enable using the right mouse button to cancel out of menus and scroll the
map.
``mousequery edge enable``
``mousequery delay 300``
Enable edge scrolling and set the delay to 300ms.

16
plugins/mousequery.cpp
Unescape Escape View File

@ -916,19 +916,9 @@ DFhackCExport command_result plugin_init ( color_ostream &out, std::vector <Plug
{ {
commands.push_back( commands.push_back(
PluginCommand( PluginCommand(
"mousequery", "Add mouse functionality to Dwarf Fortress", "mousequery",
mousequery_cmd, false, "Add mouse functionality to Dwarf Fortress.",
"mousequery [plugin|rbutton|track|edge|live] [enable|disable]\n" mousequery_cmd));
" plugin: enable/disable the entire plugin\n"
" rbutton: enable/disable right mouse button\n"
" track: enable/disable moving cursor in build and designation mode\n"
" edge: enable/disable active edge scrolling (when on, will also enable tracking)\n"
" live: enable/disable query view when unpaused\n\n"
"mousequery drag [left|right|disable]\n"
" Enable/disable map dragging with the specified mouse button\n\n"
"mousequery delay <amount>\n"
" Set delay when edge scrolling in tracking mode. Omit amount to display current setting.\n"
));
return CR_OK; return CR_OK;
} }