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

update docs for dig

develop
myk002 2022-07-23 22:40:33 -07:00
parent 932f1c2189
commit 9dd62f2291
No known key found for this signature in database
GPG Key ID: 8A39CA0FA0C16E78
1 changed files with 103 additions and 74 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

177
docs/plugins/dig.rst
Unescape Escape View File

@ -27,101 +27,130 @@ Usage:
Also cross z-levels, digging stairs as needed. Alias for ``digl x``. Also cross z-levels, digging stairs as needed. Alias for ``digl x``.
``digcircle [<diameter>] [<solidity>] [<action>] [<designation>] [-p<number>]`` ``digcircle [<diameter>] [<solidity>] [<action>] [<designation>] [-p<number>]``
Designate circles. The diameter is the number of tiles across the center of Designate circles. The diameter is the number of tiles across the center of
the circle that you want to dig. See the `digcircle`_ section below for an the circle that you want to dig. See the `digcircle`_ section below for
explanation of the options. options.
``digtype [<designation>] ``digtype [<designation>] [-p<number>]``
For every tile on the map of the same vein type as the selected tile, Designate all vein tiles of the selected type. See the `digtype`_ section
this command designates it to have the same designation as the below for options.
selected tile. If the selected tile has no designation, they will be ``digexp [<pattern>] [<filter>] [-p<number>]``
dig designated. Designate dig patterns for exploratory mining. See the `digexp`_ section
below for options
``digexp [<pattern>] [<filter>]
All commands support specifying the priority of the dig designations with
.. note:: ``-p<number>``, where the number is from 1 to 7. If a priority is not specified,
the priority selected in-game is used as the default.
All commands implemented by the `dig` plugin (listed by ``ls dig``) support
specifying the designation priority with ``-p#``, ``-p #``, or ``p=#``, Examples
where ``#`` is a number from 1 to 7. If a priority is not specified, the --------
priority selected in-game is used as the default.
``digcircle filled 3``
Dig a filled circle with a diameter of 3 tiles.
``digcircle``
Do it again (previous parameters are reused).
``expdig diag5 hidden``
Designate the diagonal 5 pattern over all hidden tiles on the current
z-level.
``expdig ladder designated``
Take existing designations on the current z-level and replace them with the
ladder pattern.
``expdig``
Do it again (previous parameters are reused).
digcircle digcircle
========= ---------
Designate filled or hollow circles. If neither ``hollow`` nor ``filled`` The ``digcircle`` command can accept up to one option of each type below.
is specified, the default is ``hollow``. The diameter is the number of tiles
Action:
:set: Set designation (default) Solidity options:
:unset: Unset current designation
:invert: Invert designations already present
Designation types: ``hollow``
Designates hollow circles (default).
``filled``
Designates filled circles.
:dig: Normal digging designation (default) Action options:
:ramp: Ramp digging
:ustair: Staircase up
:dstair: Staircase down
:xstair: Staircase up/down
:chan: Dig channel
After you have set the options, the command called with no options ``set``
repeats with the last selected parameters. Set designation (default).
``unset``
Unset current designation.
``invert``
Invert designations already present.
Examples: Designation options:
``digcircle filled 3`` ``dig``
Dig a filled circle with diameter = 3. Normal digging designation (default).
``digcircle`` ``ramp``
Do it again. Dig ramps.
``ustair``
Dig up staircases.
``dstair``
Dig down staircases.
``xstair``
Dig up/down staircases.
``chan``
Dig channels.
After you have set the options, the command called with no options repeats with
the last selected parameters.
digtype digtype
======= -------
For every tile on the map of the same vein type as the selected tile,
this command designates it to have the same designation as the For every tile on the map of the same vein type as the selected tile, this
selected tile. If the selected tile has no designation, they will be command designates it to have the same designation as the selected tile. If the
dig designated. selected tile has no designation, they will be dig designated.
If an argument is given, the designation of the selected tile is
ignored, and all appropriate tiles are set to the specified If an argument is given, the designation of the selected tile is ignored, and
designation. all appropriate tiles are set to the specified designation.
Options: Designation options:
:dig: ``dig``
:channel: Normal digging designation.
:ramp: ``channel``
:updown: up/down stairs Dig channels.
:up: up stairs ``ramp``
:down: down stairs Dig ramps.
:clear: clear designation ``updown``
Dig up/down staircases.
``up``
Dig up staircases.
``down``
Dig down staircases.
``clear``
Clear any designations.
digexp digexp
====== ------
This command is for :wiki:`exploratory mining <Exploratory_mining>`. This command is for :wiki:`exploratory mining <Exploratory_mining>`.
There are two variables that can be set: pattern and filter. There are two variables that can be set: pattern and filter.
Patterns: Patterns:
:diag5: diagonals separated by 5 tiles ``diag5``
:diag5r: diag5 rotated 90 degrees Diagonals separated by 5 tiles.
:ladder: A 'ladder' pattern ``diag5r``
:ladderr: ladder rotated 90 degrees The diag5 pattern rotated 90 degrees.
:clear: Just remove all dig designations ``ladder``
:cross: A cross, exactly in the middle of the map. A 'ladder' pattern.
``ladderr``
The ladder pattern rotated 90 degrees.
``cross``
A cross, exactly in the middle of the map.
``clear``
Just remove all dig designations.
Filters: Filters:
:all: designate whole z-level ``hidden``
:hidden: designate only hidden tiles of z-level (default) Designate only hidden tiles of z-level (default)
:designated: Take current designation and apply pattern to it. ``all``
Designate the whole z-level.
``designated``
Take current designation and apply the selected pattern to it.
After you have a pattern set, you can use ``expdig`` to apply it again. After you have a pattern set, you can use ``expdig`` to apply it again.
Examples:
``expdig diag5 hidden``
Designate the diagonal 5 patter over all hidden tiles
``expdig``
Apply last used pattern and filter
``expdig ladder designated``
Take current designations and replace them with the ladder pattern