From 2bd0e938addbd1b59f7fbc90e98f448128da8f90 Mon Sep 17 00:00:00 2001 From: lethosor Date: Tue, 20 Oct 2020 01:11:01 -0400 Subject: [PATCH] Move pathable to Lua API docs --- docs/Lua API.rst | 13 +++++++++++++ docs/Plugins.rst | 18 +++--------------- 2 files changed, 16 insertions(+), 15 deletions(-) diff --git a/docs/Lua API.rst b/docs/Lua API.rst index 2cf9e5db1..ecc9ef88e 100644 --- a/docs/Lua API.rst +++ b/docs/Lua API.rst @@ -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). +.. _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 ==== diff --git a/docs/Plugins.rst b/docs/Plugins.rst index f9ce3184c..f96bd78de 100644 --- a/docs/Plugins.rst +++ b/docs/Plugins.rst @@ -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 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 @@ -2971,9 +2958,10 @@ Lua API Some plugins consist solely of native libraries exposed to Lua. They are listed in the `lua-api` file under `lua-plugins`: -* `eventful` * `building-hacks` +* `cxxrandom` +* `eventful` * `luasocket` * `map-render` -* `cxxrandom` +* `pathable` * `xlsxreader`