dfhack/docs
Myk Taylor 82013c0c5e prep buildingplan for core algorithm changes
Lots of refactoring and reorganizing, with only cosmetic player-visible changes.

- show quickfort mode hotlkey label regardless of whether the current building type has buildingplan enabled. before, it was only shown after the user enabled buildingplan for the current building. this eliminates the extra step when enabling quickfort mode, which force-enables all building types.
- changed signature of lua-exported isPlannableBuilding to take subtype
  and custom type in addition to building type. this is only used by
  quickfort, and it already sends all three params in preparation for
  this change
- added lua-exported scheduleCycle(), which is like doCycle(), but only
  takes effect on the next non-paused frame. this lets quickfort
  run only one buildingplan cycle regardless of how many #build
  blueprints were run
- declared a few dfhack library methods and params const so buildingplan
  could call them from const methods
- converted buildingplan internal debug logging fn to have a printf api
- reshaped buildingplan-planner API and refactored implementation in
  preparation for upcoming core algorithm changes for supporing all
  building types (no externally-visible functionality changes)
  - changed df::building_type params to type, subtype, custom tuple keys
  - introduced capability to return multiple filters per building type
    (though the current buildings all only have one filter per)
- split monolith hook functions in buildingplan.cpp into one per scope.
  this significantly cleans up the code and preps the hooks to handle
  iterating through multiple item filters.
- got rid of send_key function and replaced with better reporting of
  whether keys have been handled
2020-10-16 13:52:23 -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 Convert some links to use :wiki: 2020-10-09 19:24:52 -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 prep buildingplan for core algorithm changes 2020-10-16 13:52:23 -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 Update docs (#1652) 2020-10-09 21:43:58 -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 dwarfmonitor prefs: fix segfault if item_subtype is null for some item types 2020-10-11 20:45:56 -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