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

update docs for automaterial

develop
myk002 2022-07-18 16:13:04 -07:00
parent 87e67ea8b3
commit 0ba3a4684b
No known key found for this signature in database
GPG Key ID: 8A39CA0FA0C16E78
1 changed files with 33 additions and 21 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

54
docs/plugins/automaterial.rst
Unescape Escape View File

@ -1,33 +1,45 @@
automaterial automaterial
============ ============
This makes building constructions (walls, floors, fortifications, etc) a little bit
easier by saving you from having to trawl through long lists of materials each time
you place one.
Firstly, it moves the last used material for a given construction type to the top of Sorts building materials by recent usage. This makes building constructions
the list, if there are any left. So if you build a wall with chalk blocks, the next (walls, floors, fortifications, etc) much easier by saving you from having to
time you place a wall the chalk blocks will be at the top of the list, regardless of trawl through long lists of materials each time you place one.
distance (it only does this in "grouped" mode, as individual item lists could be huge).
This should mean you can place most constructions without having to search for your It moves the last used material for a given construction type to the top of the
preferred material type. list, if there are any left. So if you build a wall with chalk blocks, the next
time you place a wall the chalk blocks will be at the top of the list,
regardless of distance (it only does this in "grouped" mode, as individual item
lists could be huge). This means you can place most constructions without having
to search for your preferred material type.
Usage::
enable automaterial
.. image:: ../images/automaterial-mat.png .. image:: ../images/automaterial-mat.png
Pressing :kbd:`a` while highlighting any material will enable that material for "auto select" Pressing :kbd:`a` while highlighting any material will enable that material for
for this construction type. You can enable multiple materials as autoselect. Now the next "auto select" for this construction type. You can enable multiple materials. Now
time you place this type of construction, the plugin will automatically choose materials the next time you place this type of construction, the plugin will automatically
for you from the kinds you enabled. If there is enough to satisfy the whole placement, choose materials for you from the kinds you enabled. If there is enough to
you won't be prompted with the material screen - the construction will be placed and you satisfy the whole placement, you won't be prompted with the material screen at
will be back in the construction menu as if you did it manually. all -- the construction will be placed and you will be back in the construction
menu.
When choosing the construction placement, you will see a couple of options: When choosing the construction placement, you will see a couple of options:
.. image:: ../images/automaterial-pos.png .. image:: ../images/automaterial-pos.png
Use :kbd:`a` here to temporarily disable the material autoselection, e.g. if you need Use :kbd:`a` here to temporarily disable the material autoselection, e.g. if you
to go to the material selection screen so you can toggle some materials on or off. need to go to the material selection screen so you can toggle some materials on
or off.
The other option (auto type selection, off by default) can be toggled on with
:kbd:`t`. If you toggle this option on, instead of returning you to the main
construction menu after selecting materials, it returns you back to this screen.
If you use this along with several autoselect enabled materials, you should be
able to place complex constructions more conveniently.
The other option (auto type selection, off by default) can be toggled on with :kbd:`t`. If you The ``automaterial`` plugin also enables extra contruction placement modes, such
toggle this option on, instead of returning you to the main construction menu after selecting as designating areas larger than 10x10 and allowing you to designate hollow
materials, it returns you back to this screen. If you use this along with several autoselect rectangles instead of the default filled ones.
enabled materials, you should be able to place complex constructions more conveniently.