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

Clean up plugin mkmodule/require explanation

develop
lethosor 2020-09-24 00:16:32 -04:00
parent 945cd2e43e
commit 3c037ef52a
No known key found for this signature in database
GPG Key ID: 76A269552F4F58C1
1 changed files with 10 additions and 7 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

17
docs/Lua API.rst
Unescape Escape View File

@ -3656,19 +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.
In addition to any native functions documented here, plugins that can be In addition to any native functions documented here, plugins that can be
disabled (that is, plugins that support the enable/disable API) will have the enabled (that is, plugins that support the `enable/disable API <enable>`) will
following functions defined: have the following functions defined:
* ``isEnabled()`` returns whether the plugin is enabled. * ``isEnabled()`` returns whether the plugin is enabled.
* ``setEnabled(boolean)`` sets whether the plugin is enabled. * ``setEnabled(boolean)`` sets whether the plugin is enabled.
The following plugins have lua support. 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
========= =========