summaryrefslogtreecommitdiff
path: root/Lua API.html
diff options
context:
space:
mode:
authorAlexander Gavrilov2012-04-10 11:43:36 +0400
committerAlexander Gavrilov2012-04-10 11:43:36 +0400
commit93c795cfc3eebf60157cc56e5aa38c521a60b0b3 (patch)
tree3a309cae9b42f6b5440885087daedb88fff1733f /Lua API.html
parent0e0740fddf26a849c97c26bd8e6dcb6cf58b9bf9 (diff)
downloaddfhack-93c795cfc3eebf60157cc56e5aa38c521a60b0b3.tar.gz
dfhack-93c795cfc3eebf60157cc56e5aa38c521a60b0b3.tar.bz2
dfhack-93c795cfc3eebf60157cc56e5aa38c521a60b0b3.tar.xz
Job module api tweaks: add a namespace to match others and some funcs.
Diffstat (limited to 'Lua API.html')
-rw-r--r--Lua API.html13
1 files changed, 12 insertions, 1 deletions
diff --git a/Lua API.html b/Lua API.html
index 82943fad..89e15803 100644
--- a/Lua API.html
+++ b/Lua API.html
@@ -873,15 +873,26 @@ The is_bright boolean actually seems to invert the brightness.</p>
<li><p class="first"><tt class="docutils literal">dfhack.job.printJobDetails(job)</tt></p>
<p>Prints info about the job.</p>
</li>
-<li><p class="first"><tt class="docutils literal">dfhack.job.getJobHolder(job)</tt></p>
+<li><p class="first"><tt class="docutils literal">dfhack.job.printItemDetails(jobitem,idx)</tt></p>
+<p>Prints info about the job item.</p>
+</li>
+<li><p class="first"><tt class="docutils literal">dfhack.job.getHolder(job)</tt></p>
<p>Returns the building holding the job.</p>
</li>
+<li><p class="first"><tt class="docutils literal">dfhack.job.getWorker(job)</tt></p>
+<p>Returns the unit performing the job.</p>
+</li>
<li><p class="first"><tt class="docutils literal">dfhack.job.is_equal(job1,job2)</tt></p>
<p>Compares important fields in the job and nested item structures.</p>
</li>
<li><p class="first"><tt class="docutils literal">dfhack.job.is_item_equal(job_item1,job_item2)</tt></p>
<p>Compares important fields in the job item structures.</p>
</li>
+<li><p class="first"><tt class="docutils literal">dfhack.job.listNewlyCreated(first_id)</tt></p>
+<p>Returns the current value of <tt class="docutils literal">df.global.job_next_id</tt>, and
+if there are any jobs with <tt class="docutils literal">first_id &lt;= id &lt; job_next_id</tt>,
+a lua list containing them.</p>
+</li>
</ul>
</div>
<div class="section" id="units-module">