Move pathable to Lua API docs

develop
lethosor 2020-10-20 01:11:01 -04:00
parent 84973d1fb8
commit 2bd0e938ad
No known key found for this signature in database
GPG Key ID: 76A269552F4F58C1
2 changed files with 16 additions and 15 deletions

@ -4207,6 +4207,19 @@ Functions
returns a table with w*h*4 entries of rendered tiles. The format is same as ``df.global.gps.screen`` (tile,foreground,bright,background). returns a table with w*h*4 entries of rendered tiles. The format is same as ``df.global.gps.screen`` (tile,foreground,bright,background).
.. _pathable:
pathable
========
This plugin implements the back end of the `gui/pathable` script. It exports a
single Lua function, in ``hack/lua/plugins/pathable.lua``:
* ``paintScreen(cursor[,skip_unrevealed])``: Paint each visible of the screen
green or red, depending on whether it can be pathed to from the tile at
``cursor``. If ``skip_unrevealed`` is specified and true, do not draw
unrevealed tiles.
sort sort
==== ====

@ -117,19 +117,6 @@ A tool for checking how many tiles contain flowing liquids. If you suspect that
your magma sea leaks into HFS, you can use this tool to be sure without your magma sea leaks into HFS, you can use this tool to be sure without
revealing the map. revealing the map.
.. _pathable:
pathable
========
This plugin implements the back end of the `gui/pathable` script. It exports a
single Lua function, in ``hack/lua/plugins/pathable.lua``:
* ``paintScreen(cursor[,skip_unrevealed])``: Paint each visible of the screen
green or red, depending on whether it can be pathed to from the tile at
``cursor``. If ``skip_unrevealed`` is specified and true, do not draw
unrevealed tiles.
.. _probe: .. _probe:
probe probe
@ -2971,9 +2958,10 @@ Lua API
Some plugins consist solely of native libraries exposed to Lua. They are listed Some plugins consist solely of native libraries exposed to Lua. They are listed
in the `lua-api` file under `lua-plugins`: in the `lua-api` file under `lua-plugins`:
* `eventful`
* `building-hacks` * `building-hacks`
* `cxxrandom`
* `eventful`
* `luasocket` * `luasocket`
* `map-render` * `map-render`
* `cxxrandom` * `pathable`
* `xlsxreader` * `xlsxreader`