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

Fixed whitespace issues that cause a failed build on lint.

develop
Gabe Rau 2021-03-20 01:55:45 -06:00
parent e6639180db
commit 374fc763eb
1 changed files with 7 additions and 7 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

14
docs/Lua API.rst
Unescape Escape View File

@ -4418,20 +4418,20 @@ General script API
Example:: Example::
dfhack.run_script("armoks-blessing", "all") dfhack.run_script("armoks-blessing", "all")
Scipts that use a dash(``-``) in their arguments still require one when called Scipts that use a dash(``-``) in their arguments still require one when called
from ``dfhack.run_script``. from ``dfhack.run_script``.
Example:: Example::
dfhack.run_script("gaydar", "-all") dfhack.run_script("gaydar", "-all")
Unlike ``dfhack.run_command``, ``dfhack.run_script`` allows a different Unlike ``dfhack.run_command``, ``dfhack.run_script`` allows a different
different script to be executed and its value passed as an argument to the main different script to be executed and its value passed as an argument to the main
function called by ``dfhack.run_script``. function called by ``dfhack.run_script``.
Example:: Example::
dfhack.run_script("some_script", dfhack.gui.getDwarfmodeViewDims()); dfhack.run_script("some_script", dfhack.gui.getDwarfmodeViewDims());
While this implmenation is currently a functional, its purpose and stability While this implmenation is currently a functional, its purpose and stability
are limited. As such, ``dfhack.reqscript(name)`` should be used. are limited. As such, ``dfhack.reqscript(name)`` should be used.
Note that the ``dfhack.run_script()`` function allows Lua errors propagate to the caller. Note that the ``dfhack.run_script()`` function allows Lua errors propagate to the caller.
To run other types of commands (such as built-in commands, plugin commands, or To run other types of commands (such as built-in commands, plugin commands, or