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

update docs for prospector

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

59
docs/plugins/prospector.rst
Unescape Escape View File

@ -1,43 +1,50 @@
.. _prospect:
prospect
========
prospector
==========
Tags:
:dfhack-keybind:`prospect`
**Usage:**
Shows a summary of resources that exist on the map or an estimate of resources
available in the selected embark area.
``prospect [all|hell] [<options>]``
Usage::
Shows a summary of resources that exist on the map. By default, only the visible
part of the map is scanned. Include the ``all`` keyword if you want ``prospect``
to scan the whole map as if it were revealed. Use ``hell`` instead of ``all`` if
you also want to see the Z range of HFS tubes in the 'features' report section.
prospect [all|hell] [<options>]
**Options:**
By default, only the visible part of the map is scanned. Include the ``all``
keyword if you want ``prospect`` to scan the whole map as if it were revealed.
Use ``hell`` instead of ``all`` if you also want to see the Z range of HFS
tubes in the 'features' report section.
:``-h``, ``--help``:
Shows this help text.
:``-s``, ``--show <sections>``:
Shows only the named comma-separated list of report sections. Report section
names are: summary, liquids, layers, features, ores, gems, veins, shrubs,
and trees. If run during pre-embark, only the layers, ores, gems, and veins
report sections are available.
:``-v``, ``--values``:
Includes material value in the output. Most useful for the 'gems' report
section.
**Examples:**
Examples
--------
``prospect all``
Shows the entire report for the entire map.
``prospect hell --show layers,ores,veins``
Shows only the layers, ores, and other vein stone report sections, and
includes information on HFS tubes when a fort is loaded.
includes information on HFS tubes (if run on a fortress map and not the
pre-embark screen).
``prospect all -sores``
Show only information about ores for the pre-embark or fortress map report.
**Pre-embark estimate:**
Options
-------
``-s``, ``--show <sections>``
Shows only the named comma-separated list of report sections. Report section
names are: summary, liquids, layers, features, ores, gems, veins, shrubs,
and trees. If run during pre-embark, only the layers, ores, gems, and veins
report sections are available.
``-v``, ``--values``
Includes material value in the output. Most useful for the 'gems' report
section.
Pre-embark estimate
-------------------
If prospect is called during the embark selection screen, it displays an
estimate of layer stone availability. If the ``all`` keyword is specified, it
@ -48,6 +55,6 @@ the embark rectangle.
The results of pre-embark prospect are an *estimate*, and can at best be
expected to be somewhere within +/- 30% of the true amount; sometimes it
does a lot worse. Especially, it is not clear how to precisely compute how
many soil layers there will be in a given embark tile, so it can report a
whole extra layer, or omit one that is actually present.
does a lot worse. In particular, it is not clear how to precisely compute
how many soil layers there will be in a given embark tile, so it can report
a whole extra layer, or omit one that is actually present.

43
plugins/prospector.cpp
Unescape Escape View File

@ -260,46 +260,9 @@ command_result prospector (color_ostream &out, vector <string> & parameters);
DFhackCExport command_result plugin_init ( color_ostream &out, std::vector <PluginCommand> &commands)
{
commands.push_back(PluginCommand(
"prospect", "Show stats of available raw resources.",
prospector, false,
" prospect [all|hell] [<options>]\n"
"\n"
" Shows a summary of resources that exist on the map. By default,\n"
" only the visible part of the map is scanned. Include the 'all' keyword\n"
" if you want prospect to scan the whole map as if it were revealed.\n"
" Use 'hell' instead of 'all' if you also want to see the Z range of HFS\n"
" tubes in the 'features' report section.\n"
"\n"
"Options:\n"
" -h,--help\n"
" Shows this help text.\n"
" -s,--show <sections>\n"
" Shows only the named comma-separated list of report sections.\n"
" Report section names are: summary, liquids, layers, features, ores,\n"
" gems, veins, shrubs, and trees. If run during pre-embark, only the\n"
" layers, ores, gems, and veins report sections are available.\n"
" -v,--values\n"
" Includes material value in the output. Most useful for the 'gems'\n"
" report section.\n"
"\n"
"Examples:\n"
" prospect all\n"
" Shows the entire report for the entire map.\n"
"\n"
" prospect hell --show layers,ores,veins\n"
" Shows only the layers, ores, and other vein stone report sections,\n"
" and includes information on HFS tubes when a fort is loaded.\n"
"\n"
" prospect all -sores\n"
" Show only information about ores for the pre-embark or fortress map\n"
" report.\n"
"\n"
"Pre-embark estimate:\n"
" If called during the embark selection screen, displays a rough\n"
" estimate of layer stone availability. If the 'all' keyword is\n"
" specified, also estimates ores, gems, and other vein material. The\n"
" estimate covers all tiles of the embark rectangle.\n"
));
"prospect",
"Show raw resources available on the map.",
prospector));
return CR_OK;
}