diff --git a/docs/plugins/probe.rst b/docs/plugins/probe.rst index 1dcc28336..614d0bc81 100644 --- a/docs/plugins/probe.rst +++ b/docs/plugins/probe.rst @@ -1,13 +1,21 @@ probe ===== +Tags: +:dfhack-keybind:`probe` +:dfhack-keybind:`bprobe` +:dfhack-keybind:`cprobe` -This plugin provides multiple commands that print low-level properties of the -selected objects. +Display low-level properties of selected objects. -* ``probe``: prints some properties of the tile selected with :kbd:`k`. Some of - these properties can be passed into `tiletypes`. -* ``cprobe``: prints some properties of the unit selected with :kbd:`v`, as well - as the IDs of any worn items. `gui/gm-unit` and `gui/gm-editor` are more - complete in-game alternatives. -* ``bprobe``: prints some properties of the building selected with :kbd:`q` or - :kbd:`t`. `gui/gm-editor` is a more complete in-game alternative. +Usage: + +``probe`` + Displays properties of the tile selected with :kbd:`k`. Some of these + properties can be passed into `tiletypes`. +``bprobe`` + 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`. diff --git a/plugins/probe.cpp b/plugins/probe.cpp index ba7c42ede..b9b98ee75 100644 --- a/plugins/probe.cpp +++ b/plugins/probe.cpp @@ -49,20 +49,14 @@ command_result df_bprobe (color_ostream &out, vector & parameters); DFhackCExport command_result plugin_init ( color_ostream &out, std::vector &commands) { commands.push_back(PluginCommand("probe", - "A tile probe", - df_probe, - false, - "Hover the cursor over a tile to view its properties.\n")); + "Display information about the selected tile.", + df_probe)); commands.push_back(PluginCommand("cprobe", - "A creature probe", - df_cprobe, - false, - "Select a creature to view its properties.\n")); + "Display information about the selected creature.", + df_cprobe)); commands.push_back(PluginCommand("bprobe", - "A simple building probe", - df_bprobe, - false, - "Select a building to view its properties.\n")); + "Display information about the selected building.", + df_bprobe)); return CR_OK; }