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

Update Lua API.rst 

Corrected the dfhack.run_script documentation and added an example.
develop
Gabe Rau 2021-03-17 23:17:01 -06:00 committed by GitHub
parent 195db1bad9
commit a77353b2e6
No known key found for this signature in database
GPG Key ID: 4AEE18F83AFDEB23
1 changed files with 4 additions and 3 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

5
docs/Lua API.rst
Unescape Escape View File

@ -4079,10 +4079,11 @@ DFHack core invokes the scripts in the *core context* (see above);
however it is possible to call them from any lua code (including however it is possible to call them from any lua code (including
from other scripts) in any context, via the same function the core uses: from other scripts) in any context, via the same function the core uses:
* ``dfhack.run_script(name[,args...])`` * ``dfhack.run_script("name arg1 arg2 arg3")``
Run a lua script in hack/scripts/, as if it was started from dfhack command-line. Run a lua script in hack/scripts/, as if it was started from dfhack command-line.
The ``name`` argument should be the name stem, as would be used on the command line. The argument should be the exact command that would be written to the command line.
For example: dfhack.run_command("createitem WEAPON:ITEM_WEAPON_PICK COPPER 9999")
Note that this function lets errors propagate to the caller. Note that this function lets errors propagate to the caller.