summaryrefslogtreecommitdiff
path: root/Lua API.html
diff options
context:
space:
mode:
authorAlexander Gavrilov2012-09-14 18:49:02 +0400
committerAlexander Gavrilov2012-09-14 18:49:02 +0400
commit24772f4dbcfcfbf0ac3d29f72d3bda19566d8530 (patch)
treee31e06906af5a071525f69165567ea3fe232c24f /Lua API.html
parent68bfc63b7d0804ac5229623480e47f297783f502 (diff)
downloaddfhack-24772f4dbcfcfbf0ac3d29f72d3bda19566d8530.tar.gz
dfhack-24772f4dbcfcfbf0ac3d29f72d3bda19566d8530.tar.bz2
dfhack-24772f4dbcfcfbf0ac3d29f72d3bda19566d8530.tar.xz
Add an api function for destroying items.
Diffstat (limited to 'Lua API.html')
-rw-r--r--Lua API.html3
1 files changed, 3 insertions, 0 deletions
diff --git a/Lua API.html b/Lua API.html
index 168f7dcc..07f038bc 100644
--- a/Lua API.html
+++ b/Lua API.html
@@ -1213,6 +1213,9 @@ Returns <em>false</em> in case of error.</p>
<li><p class="first"><tt class="docutils literal">dfhack.items.moveToInventory(item,unit,use_mode,body_part)</tt></p>
<p>Move the item to the unit inventory. Returns <em>false</em> if impossible.</p>
</li>
+<li><p class="first"><tt class="docutils literal">dfhack.items.remove(item[, no_uncat])</tt></p>
+<p>Removes the item, and marks it for garbage collection unless <tt class="docutils literal">no_uncat</tt> is true.</p>
+</li>
<li><p class="first"><tt class="docutils literal">dfhack.items.makeProjectile(item)</tt></p>
<p>Turns the item into a projectile, and returns the new object, or <em>nil</em> if impossible.</p>
</li>