summaryrefslogtreecommitdiff
path: root/LUA_API.rst
diff options
context:
space:
mode:
authorAlexander Gavrilov2012-09-29 15:18:04 +0400
committerAlexander Gavrilov2012-09-29 15:18:04 +0400
commit48da06ec371421a48f801f6da1add6e437ccfa06 (patch)
treecb3763c4be0fe8ec96492381859bfe22dca91427 /LUA_API.rst
parent6fd002382f08ee1f39976865e143104d6249f0fd (diff)
downloaddfhack-48da06ec371421a48f801f6da1add6e437ccfa06.tar.gz
dfhack-48da06ec371421a48f801f6da1add6e437ccfa06.tar.bz2
dfhack-48da06ec371421a48f801f6da1add6e437ccfa06.tar.xz
Add an API function for reading the nominal skill level.
Diffstat (limited to 'LUA_API.rst')
-rw-r--r--LUA_API.rst5
1 files changed, 5 insertions, 0 deletions
diff --git a/LUA_API.rst b/LUA_API.rst
index f532d221..bf7ee45a 100644
--- a/LUA_API.rst
+++ b/LUA_API.rst
@@ -918,6 +918,11 @@ Units module
Returns the age of the unit in years as a floating-point value.
If ``true_age`` is true, ignores false identities.
+* ``dfhack.units.getNominalSkill(unit, skill[, use_rust])``
+
+ Retrieves the nominal skill level for the given unit. If ``use_rust``
+ is *true*, subtracts the rust penalty.
+
* ``dfhack.units.getEffectiveSkill(unit, skill)``
Computes the effective rating for the given skill, taking into account exhaustion, pain etc.