From 7bac4c89c46df138a47017ece335ae102b0427ea Mon Sep 17 00:00:00 2001 From: lethosor Date: Wed, 19 Aug 2020 17:12:40 -0400 Subject: [PATCH] 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 --- docs/Lua API.rst | 14 ++++++++------ 1 file changed, 8 insertions(+), 6 deletions(-) diff --git a/docs/Lua API.rst b/docs/Lua API.rst index 226c93aa2..5450aee45 100644 --- a/docs/Lua API.rst +++ b/docs/Lua API.rst @@ -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()``