document dig-now lua api

2021-06-27 21:34:49 -07:00 · 2021-06-27 21:34:49 -07:00 · 7f0c3cc7e4
parent 48f90da72e
commit 7f0c3cc7e4
1 changed files with 10 additions and 0 deletions
--- a/docs/Lua
+++ b/docs/Lua
@ -4043,6 +4043,16 @@ Lua plugin classes
 - ``shuffle()``: shuffles the sequence of numbers
 - ``next()``: returns next number in the sequence

+dig-now
+=======
+
+The dig-now plugin exposes the following functions to Lua:
+
+* ``dig_now_tile(pos)`` or ``dig_now_tile(x,y,z)``: Runs dig-now for the
+    specified tile coordinate. Default options apply, as if you were running the
+    command ``dig-now <pos> <pos>``. See the `dig-now` documentation for details
+    on default settings.
+
 .. _eventful:

 eventful