add docs for plugins that only provide Lua apis

develop
myk002 2022-07-27 15:48:11 -07:00
parent 10f8417cc2
commit e677e8098d
No known key found for this signature in database
GPG Key ID: 8A39CA0FA0C16E78
8 changed files with 49 additions and 7 deletions

@ -4287,7 +4287,7 @@ blueprint files:
The names of the functions are also available as the keys of the
``valid_phases`` table.
.. _building-hacks:
.. _building-hacks-api:
building-hacks
==============
@ -4426,7 +4426,7 @@ Native functions:
The lua module file also re-exports functions from ``dfhack.burrows``.
.. _cxxrandom:
.. _cxxrandom-api:
cxxrandom
=========
@ -4596,7 +4596,7 @@ The dig-now plugin exposes the following functions to Lua:
command ``dig-now <pos> <pos>``. See the `dig-now` documentation for details
on default settings.
.. _eventful:
.. _eventful-api:
eventful
========
@ -4764,7 +4764,7 @@ Integrated tannery::
b=require "plugins.eventful"
b.addReactionToShop("TAN_A_HIDE","LEATHERWORKS")
.. _luasocket:
.. _luasocket-api:
luasocket
=========
@ -4835,7 +4835,7 @@ A class with all the tcp functionality.
Tries connecting to that address and port. Returns ``client`` object.
.. _map-render:
.. _map-render-api:
map-render
==========
@ -4851,7 +4851,7 @@ 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-api:
pathable
========
@ -4885,7 +4885,7 @@ sort
The `sort <sort>` plugin does not export any native functions as of now.
Instead, it calls Lua code to perform the actual ordering of list items.
.. _xlsxreader:
.. _xlsxreader-api:
xlsxreader
==========

@ -0,0 +1,6 @@
building-hacks
==============
Provides a Lua API for creating powered workshops.
See `building-hacks-api` for more details.

@ -0,0 +1,6 @@
cxxrandom
=========
Provides a Lua API for random distributions.
See `cxxrandom-api` for details.

@ -0,0 +1,6 @@
eventful
========
Provides a Lua API for reacting to in-game events.
See `eventful-api` for details.

@ -0,0 +1,6 @@
luasocket
=========
Provides a Lua API for accessing network sockets.
See `luasocket-api` for details.

@ -0,0 +1,6 @@
map-render
==========
Provides a Lua API for rerendering portions of the map.
See `map-render-api` for details.

@ -0,0 +1,6 @@
pathable
========
Provides a Lua API for marking tiles that are reachable from the cursor.
See `pathable-api` for details.

@ -0,0 +1,6 @@
xlsxreader
==========
Provides a Lua API for reading .xlsx files.
See `xlsxreader-api` for details.