summaryrefslogtreecommitdiff
path: root/Lua API.html
diff options
context:
space:
mode:
authorAlexander Gavrilov2012-05-22 12:31:37 +0400
committerAlexander Gavrilov2012-05-22 12:31:37 +0400
commit9adf310d7f162ba58da764bed2c918487c692f6b (patch)
treed253f45cf76c8bae4f4926eb0f841eebf3dc5deb /Lua API.html
parent20794ebf191d21d5acce274d70bdad4012deaa44 (diff)
downloaddfhack-9adf310d7f162ba58da764bed2c918487c692f6b.tar.gz
dfhack-9adf310d7f162ba58da764bed2c918487c692f6b.tar.bz2
dfhack-9adf310d7f162ba58da764bed2c918487c692f6b.tar.xz
Update Units::isCitizen after looking at game-over detection code.
Diffstat (limited to 'Lua API.html')
-rw-r--r--Lua API.html11
1 files changed, 9 insertions, 2 deletions
diff --git a/Lua API.html b/Lua API.html
index 4b763af2..1576652d 100644
--- a/Lua API.html
+++ b/Lua API.html
@@ -960,13 +960,20 @@ a lua list containing them.</p>
<p>Returns the nemesis record of the unit if it has one, or <em>nil</em>.</p>
</li>
<li><p class="first"><tt class="docutils literal">dfhack.units.isDead(unit)</tt></p>
-<p>The unit is completely dead and passive.</p>
+<p>The unit is completely dead and passive, or a ghost.</p>
</li>
<li><p class="first"><tt class="docutils literal">dfhack.units.isAlive(unit)</tt></p>
<p>The unit isn't dead or undead.</p>
</li>
<li><p class="first"><tt class="docutils literal">dfhack.units.isSane(unit)</tt></p>
-<p>The unit is capable of rational action, i.e. not dead, insane or zombie.</p>
+<p>The unit is capable of rational action, i.e. not dead, insane, zombie, or active werewolf.</p>
+</li>
+<li><p class="first"><tt class="docutils literal">dfhack.units.isDwarf(unit)</tt></p>
+<p>The unit is of the correct race of the fortress.</p>
+</li>
+<li><p class="first"><tt class="docutils literal">dfhack.units.isCitizen(unit)</tt></p>
+<p>The unit is an alive sane citizen of the fortress; wraps the
+same checks the game uses to decide game-over by extinction.</p>
</li>
<li><p class="first"><tt class="docutils literal"><span class="pre">dfhack.units.getAge(unit[,true_age])</span></tt></p>
<p>Returns the age of the unit in years as a floating-point value.