dfhack/docs
Myk Taylor 22ac163d55 improve UX between automaterial and buildingplan
solves the confusing behavior when both automaterial and buildingplan
are enabled for constructions. the two plugins now communicate with each
other over the Lua layer to negotiate consistent behavior.

if neither plugin is enabled, the standard DF UI acts as normal

if automaterial is enabled but buildingplan is not, then automaterial
behavior is unchanged.

if buildingplan is enabled and automaterial is not then behavior is
the same as other buildings with buildingplan (no material selection
screen, screen stays on building placement screen after placement).
this commit fixes a bug, though, where buildingplan would only lay
down a single tile of contruction instead of a solid block when a
block is requested.

if both plugins are enabled but buildingplan is not enabled for the
building type then automaterial is unchanged from previous behavior,
execpt for an additional header showing the separation between
automaterial hotkeys and buildingplan hotkeys.

finally, if both plugins are enabled and buildingplan is enabled for the
building type then buildingplan behavior prevails, but the box select and
hollow designations features of automaterial are still usable and
useful. the 'Auto Mat-select', 'Reselect Type', and "Open Placement"
automaterial hotkeys are hidden in the UI and ignored in the feed. This
is because buildingplan takes over material selection, so 'Auto
Mat-select' doesn't make sense. Buildingplan also already stays on the
placement screen after placement, so 'Reselect Type' is not necessary.
And all buildingplan-placed buildings have relaxed placement
restrictions (e.g. they can be built in mid-air) so 'Open Placement' is
also not necessary. The missing options are replaced with blank lines so
the vertical alignment of all other options stays constant.

we also remove a few extra lua_pop() calls that are made superfluous by
the StackUnwinder.
2020-10-29 11:00:49 -07:00
..
_auto Ensure that docs/_auto/ exists 2018-04-02 14:14:03 -04:00
_changelogs Add an option to generate changelogs for individual versions 2018-04-05 11:55:25 -04:00
api Add rudimentary map docs with tile descriptions from @AtomicChicken 2020-07-28 00:38:22 -04:00
guides Fix ordered list 2020-10-28 00:01:51 -04:00
images Merge pull request #1403 from BenLubar/imgbot 2018-11-14 16:43:36 -05:00
sphinx_extensions/dfhack Default to a basic DFHack-specific pygments lexer (supporting comments and prompts) 2020-10-09 00:27:22 -04:00
styles Allow breaking long inline code snippets if necessary 2020-10-09 12:16:25 -04:00
templates Add explicit home link to sidebar 2020-07-12 00:30:28 -04:00
Authors.rst Update docs (#1652) 2020-10-09 21:43:58 -04:00
Binpatches.rst Set language of some code blocks to enable syntax highlighting 2020-10-09 01:15:42 -04:00
Compile.rst Update some docs links to use HTTPS 2020-10-09 19:17:59 -04:00
Contributing.rst Update/expand Contributing.rst regarding pull requests 2020-08-06 02:30:17 -04:00
Core.rst Update some docs links to use HTTPS 2020-10-09 19:17:59 -04:00
Dev-intro.rst Split remote API info into separate doc, add example tools and clients 2020-07-19 01:13:43 -04:00
Documentation.rst Update some docs links to use HTTPS 2020-10-09 19:17:59 -04:00
History.rst Update some docs links to use HTTPS 2020-10-09 19:17:59 -04:00
Installing.rst Mention some third-party Linux packages 2020-10-13 00:24:29 -04:00
Introduction.rst Update some docs links to use HTTPS 2020-10-09 19:17:59 -04:00
Lua API.rst improve UX between automaterial and buildingplan 2020-10-29 11:00:49 -07:00
Memory-research.rst Set language of some code blocks to enable syntax highlighting 2020-10-09 01:15:42 -04:00
NEWS-dev.rst Remove top-level links from TOCs 2020-07-08 02:13:37 -04:00
NEWS.rst Remove top-level links from TOCs 2020-07-08 02:13:37 -04:00
Plugins.rst Use keyboard formatting 2020-10-28 00:19:26 -04:00
Remote.rst Reorganize dev docs TOC, add label to remote TOC 2020-07-28 00:21:23 -04:00
Removed.rst Move Scripts-removed.rst to Removed.rst and update a bit 2020-07-08 21:04:23 -04:00
Scripts.rst Misc updates, links 2020-07-08 23:46:38 -04:00
Structures-intro.rst Move structures overview to Structures-intro.rst and update/elaborate 2020-07-08 23:11:02 -04:00
build-pdf.sh Document PDF build process and add a script for it 2020-07-15 21:42:43 -04:00
build.sh Document PDF build process and add a script for it 2020-07-15 21:42:43 -04:00
changelog.txt Merge remote-tracking branch 'myk002/buildingplan_building_material_filters' into develop 2020-10-28 23:57:55 -04:00
gen_changelog.py Add gen_changelog.py compatibility shim, fix paths when run under cmake 2020-07-04 02:35:55 -04:00
index-about.rst Move changelog, license, authors into main TOC tree 2020-07-11 23:55:02 -04:00
index-dev.rst Add rudimentary map docs with tile descriptions from @AtomicChicken 2020-07-28 00:38:22 -04:00
index.html Fix html redirection to the docs 2016-04-11 09:30:05 +10:00