summaryrefslogtreecommitdiff
path: root/Lua API.html
diff options
context:
space:
mode:
authorAlexander Gavrilov2012-04-26 12:03:56 +0400
committerAlexander Gavrilov2012-04-26 12:03:56 +0400
commit6ab270d129e098f0200824a798ad2117a6ec33c8 (patch)
tree810653df30a44eb8054587e85da91b1a2eb72883 /Lua API.html
parent9489c6ed1afd33790adc2e0b4e3c0152da8203e0 (diff)
downloaddfhack-6ab270d129e098f0200824a798ad2117a6ec33c8.tar.gz
dfhack-6ab270d129e098f0200824a798ad2117a6ec33c8.tar.bz2
dfhack-6ab270d129e098f0200824a798ad2117a6ec33c8.tar.xz
Retrieve unit noble position info, and use it in getProfessionName.
Diffstat (limited to 'Lua API.html')
-rw-r--r--Lua API.html9
1 files changed, 7 insertions, 2 deletions
diff --git a/Lua API.html b/Lua API.html
index 916c6eef..def3790c 100644
--- a/Lua API.html
+++ b/Lua API.html
@@ -959,8 +959,13 @@ a lua list containing them.</p>
<p>Returns the age of the unit in years as a floating-point value.
If <tt class="docutils literal">true_age</tt> is true, ignores false identities.</p>
</li>
-<li><p class="first"><tt class="docutils literal"><span class="pre">dfhack.units.getProfessionName(unit[,plural])</span></tt></p>
-<p>Retrieves the profession name using custom profession or raws.</p>
+<li><p class="first"><tt class="docutils literal">dfhack.units.getNoblePositions(unit)</tt></p>
+<p>Returns a list of tables describing noble position assignments, or <em>nil</em>.
+Every table has fields <tt class="docutils literal">entity</tt>, <tt class="docutils literal">assignment</tt> and <tt class="docutils literal">position</tt>.</p>
+</li>
+<li><p class="first"><tt class="docutils literal"><span class="pre">dfhack.units.getProfessionName(unit[,ignore_noble,plural])</span></tt></p>
+<p>Retrieves the profession name using custom profession, noble assignments
+or raws. The <tt class="docutils literal">ignore_noble</tt> boolean disables the use of noble positions.</p>
</li>
<li><p class="first"><tt class="docutils literal"><span class="pre">dfhack.units.getCasteProfessionName(race,caste,prof_id[,plural])</span></tt></p>
<p>Retrieves the profession name for the given race/caste using raws.</p>