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

document all_enabled setting

develop
myk002 2021-01-28 21:50:43 -08:00
parent 10634b8ae5
commit 7f62c12a83
No known key found for this signature in database
GPG Key ID: 8A39CA0FA0C16E78
1 changed files with 20 additions and 17 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

37
docs/Plugins.rst
Unescape Escape View File

@ -765,29 +765,32 @@ and displayed with::
The available settings are:
+----------------+---------+---------------------------------------+
| Setting | Default | Description |
+================+=========+=======================================+
| blocks | true | Allow blocks, boulders, logs, or bars |
+----------------+---------+ to be matched for generic "building |
| boulders | true | material" items |
+----------------+---------+ |
| logs | true | |
+----------------+---------+ |
| bars | false | |
+----------------+---------+---------------------------------------+
| quickfort_mode | false | Enable compatibility mode for the |
| | | legacy Python Quickfort (not required |
| | | for DFHack quickfort) |
+----------------+---------+---------------------------------------+
+----------------+---------+-----------+---------------------------------------+
| Setting | Default | Persisted | Description |
+================+=========+===========+=======================================+
| all_enabled | false | no | Enable planning mode for all building |
| | | | types. |
+----------------+---------+-----------+---------------------------------------+
| blocks | true | yes | Allow blocks, boulders, logs, or bars |
+----------------+---------+ | to be matched for generic "building |
| boulders | true | | material" items |
+----------------+---------+ | |
| logs | true | | |
+----------------+---------+ | |
| bars | false | | |
+----------------+---------+-----------+---------------------------------------+
| quickfort_mode | false | no | Enable compatibility mode for the |
| | | | legacy Python Quickfort (not required |
| | | | for DFHack quickfort) |
+----------------+---------+-----------+---------------------------------------+
For example, to ensure you only use blocks when a "building material" item is required, you
could add this to your ``onMapLoad.init`` file::
on-new-fortress buildingplan set boulders false; buildingplan set logs false
You only need to set the settings for new fortresses since your current filter settings
are saved with your game.
Persisted settings (i.e. ``blocks``, ``boulders``, ``logs``, and ``bars``) are saved with
your game, so you only need to set them to the values you want once.
.. _confirm: