MetzNet
/
dfhack
3
0
Fork 0
Code Issues Pull Requests Packages Projects Releases Wiki Activity

Merge remote-tracking branch 'upstream/develop' into buildingplan_refactor

develop
Myk Taylor 2020-09-26 23:45:28 -07:00
parent 1c2761f903 3c037ef52a
commit d9d949096e
1 changed files with 16 additions and 6 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

22
docs/Lua API.rst
Unescape Escape View File

@ -3656,12 +3656,22 @@ Plugins
.. contents:: .. contents::
:local: :local:
DFHack plugins may export native functions and events DFHack plugins may export native functions and events to Lua contexts. These are
to lua contexts. They are automatically imported by exposed as ``plugins.<name>`` modules, which can be imported with
``mkmodule('plugins.<name>')``; this means that a lua ``require('plugins.<name>')``. The plugins listed in this section expose
module file is still necessary for ``require`` to read. functions and/or data to Lua in this way.
The following plugins have lua support. In addition to any native functions documented here, plugins that can be
enabled (that is, plugins that support the `enable/disable API <enable>`) will
have the following functions defined:
* ``isEnabled()`` returns whether the plugin is enabled.
* ``setEnabled(boolean)`` sets whether the plugin is enabled.
For plugin developers, note that a Lua file in ``plugins/lua`` is required for
``require()`` to work, even if it contains no pure-Lua functions. This file must
contain ``mkmodule('plugins.<name>')`` to import any native functions defined in
the plugin. See existing files in ``plugins/lua`` for examples.
blueprint blueprint
========= =========