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

update docs for probe

develop
myk002 2022-07-28 23:04:07 -07:00
parent 1bbe996d58
commit cf69a1a2cf
No known key found for this signature in database
GPG Key ID: 8A39CA0FA0C16E78
2 changed files with 23 additions and 21 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

26
docs/plugins/probe.rst
Unescape Escape View File

@ -1,13 +1,21 @@
probe probe
===== =====
Tags:
:dfhack-keybind:`probe`
:dfhack-keybind:`bprobe`
:dfhack-keybind:`cprobe`
This plugin provides multiple commands that print low-level properties of the Display low-level properties of selected objects.
selected objects.
* ``probe``: prints some properties of the tile selected with :kbd:`k`. Some of Usage:
these properties can be passed into `tiletypes`.
* ``cprobe``: prints some properties of the unit selected with :kbd:`v`, as well ``probe``
as the IDs of any worn items. `gui/gm-unit` and `gui/gm-editor` are more Displays properties of the tile selected with :kbd:`k`. Some of these
complete in-game alternatives. properties can be passed into `tiletypes`.
* ``bprobe``: prints some properties of the building selected with :kbd:`q` or ``bprobe``
:kbd:`t`. `gui/gm-editor` is a more complete in-game alternative. Displays properties of the building selected with :kbd:`q` or :kbd:`t`.
For deeper inspection of the building, see `gui/gm-editor`.
``cprobe``
Displays properties of the unit selected with :kbd:`v`. It also displays the
IDs of any worn items. For deeper inspection of the unit and inventory items,
see `gui/gm-unit` and `gui/gm-editor`.

18
plugins/probe.cpp
Unescape Escape View File

@ -49,20 +49,14 @@ command_result df_bprobe (color_ostream &out, vector <string> & parameters);
DFhackCExport command_result plugin_init ( color_ostream &out, std::vector <PluginCommand> &commands) DFhackCExport command_result plugin_init ( color_ostream &out, std::vector <PluginCommand> &commands)
{ {
commands.push_back(PluginCommand("probe", commands.push_back(PluginCommand("probe",
"A tile probe", "Display information about the selected tile.",
df_probe, df_probe));
false,
"Hover the cursor over a tile to view its properties.\n"));
commands.push_back(PluginCommand("cprobe", commands.push_back(PluginCommand("cprobe",
"A creature probe", "Display information about the selected creature.",
df_cprobe, df_cprobe));
false,
"Select a creature to view its properties.\n"));
commands.push_back(PluginCommand("bprobe", commands.push_back(PluginCommand("bprobe",
"A simple building probe", "Display information about the selected building.",
df_bprobe, df_bprobe));
false,
"Select a building to view its properties.\n"));
return CR_OK; return CR_OK;
} }