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

Update API docs for setJobCooldown and removeWorker, use "cooldown" for consistency with C++ 

Ref http://www.bay12forums.com/smf/index.php?topic=164123.msg8180385#msg8180385
develop
lethosor 2020-08-19 17:12:40 -04:00
parent 45a0b7b3a6
commit 7bac4c89c4
No known key found for this signature in database
GPG Key ID: 76A269552F4F58C1
1 changed files with 8 additions and 6 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

14
docs/Lua API.rst
Unescape Escape View File

@ -1076,15 +1076,17 @@ Job module
Returns the unit performing the job.
* ``dfhack.job.setJobCooldown(building,worker,timeout)``
* ``dfhack.job.setJobCooldown(building,worker,cooldown)``
Prevent the worker from taking jobs at the specified workshop for the specified time.
This doesn't decrease the timeout in any circumstances.
Prevent the worker from taking jobs at the specified workshop for the
specified cooldown period (in ticks). This doesn't decrease the cooldown
period in any circumstances.
* ``dfhack.job.removeWorker(job,timeout)``
* ``dfhack.job.removeWorker(job,cooldown)``
Removes the worker from the specified workshop job, and sets the cooldown.
Returns *true* on success.
Removes the worker from the specified workshop job, and sets the cooldown
period (using the same logic as ``setJobCooldown``). Returns *true* on
success.
* ``dfhack.job.checkBuildingsNow()``