summaryrefslogtreecommitdiff
path: root/Lua API.html
diff options
context:
space:
mode:
authorAlexander Gavrilov2012-04-07 19:08:30 +0400
committerAlexander Gavrilov2012-04-07 19:08:30 +0400
commit45ae2ed67f9aba4d635a7565253bd9098a87bbde (patch)
tree5cf1e6c898d4ab96bcba52f520aa8404f65b7ce4 /Lua API.html
parente74788cb26edd41e484071ac3a371422c6be8773 (diff)
downloaddfhack-45ae2ed67f9aba4d635a7565253bd9098a87bbde.tar.gz
dfhack-45ae2ed67f9aba4d635a7565253bd9098a87bbde.tar.bz2
dfhack-45ae2ed67f9aba4d635a7565253bd9098a87bbde.tar.xz
Pull a few utility functions into the core and publish to lua.
Diffstat (limited to 'Lua API.html')
-rw-r--r--Lua API.html8
1 files changed, 7 insertions, 1 deletions
diff --git a/Lua API.html b/Lua API.html
index 19f912b7..569940f5 100644
--- a/Lua API.html
+++ b/Lua API.html
@@ -883,8 +883,14 @@ The is_bright boolean actually seems to invert the brightness.</p>
<div class="section" id="units-module">
<h3><a class="toc-backref" href="#id16">Units module</a></h3>
<ul>
+<li><p class="first"><tt class="docutils literal">dfhack.units.setNickname(unit,nick)</tt></p>
+<p>Sets the unit's nickname properly.</p>
+</li>
<li><p class="first"><tt class="docutils literal">dfhack.units.getVisibleName(unit)</tt></p>
-<p>Returns the name visible in game, accounting for false identities.</p>
+<p>Returns the language_name object visible in game, accounting for false identities.</p>
+</li>
+<li><p class="first"><tt class="docutils literal">dfhack.units.getNemesis(unit)</tt></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>