diff options
| author | Alexander Gavrilov | 2012-05-17 19:56:55 +0400 |
|---|---|---|
| committer | Alexander Gavrilov | 2012-05-17 19:56:55 +0400 |
| commit | 2c0024adc91491b6d687f3b56d6a5779a3391e59 (patch) | |
| tree | cba55609c91fd3a434eed0b1ac2a05f3da35b295 /Lua API.html | |
| parent | efdb709284d393938db6b60185ee3898cb068954 (diff) | |
| download | dfhack-2c0024adc91491b6d687f3b56d6a5779a3391e59.tar.gz dfhack-2c0024adc91491b6d687f3b56d6a5779a3391e59.tar.bz2 dfhack-2c0024adc91491b6d687f3b56d6a5779a3391e59.tar.xz | |
Make Items::getPosition exactly match the DF original in behavior.
Diffstat (limited to 'Lua API.html')
| -rw-r--r-- | Lua API.html | 4 |
1 files changed, 2 insertions, 2 deletions
diff --git a/Lua API.html b/Lua API.html index d44d82ba..7ce777c4 100644 --- a/Lua API.html +++ b/Lua API.html @@ -935,7 +935,7 @@ a lua list containing them.</p> <h3><a class="toc-backref" href="#id16">Units module</a></h3> <ul> <li><p class="first"><tt class="docutils literal">dfhack.units.getPosition(unit)</tt></p> -<p>Returns true <em>x,y,z</em> of the unit; may be not equal to unit.pos if caged.</p> +<p>Returns true <em>x,y,z</em> of the unit, or <em>nil</em> if invalid; may be not equal to unit.pos if caged.</p> </li> <li><p class="first"><tt class="docutils literal">dfhack.units.getContainer(unit)</tt></p> <p>Returns the container (cage) item or <em>nil</em>.</p> @@ -982,7 +982,7 @@ or raws. The <tt class="docutils literal">ignore_noble</tt> boolean disables the <h3><a class="toc-backref" href="#id17">Items module</a></h3> <ul> <li><p class="first"><tt class="docutils literal">dfhack.items.getPosition(item)</tt></p> -<p>Returns true <em>x,y,z</em> of the item; may be not equal to item.pos if in inventory.</p> +<p>Returns true <em>x,y,z</em> of the item, or <em>nil</em> if invalid; may be not equal to item.pos if in inventory.</p> </li> <li><p class="first"><tt class="docutils literal">dfhack.items.getGeneralRef(item, type)</tt></p> <p>Searches for a general_ref with the given type.</p> |
