summaryrefslogtreecommitdiff
path: root/Lua API.html
diff options
context:
space:
mode:
authorAlexander Gavrilov2012-04-11 19:42:05 +0400
committerAlexander Gavrilov2012-04-11 19:42:05 +0400
commit0c2b78b96b0aca46988f9d1e3c94f70cdfbc8e02 (patch)
tree23486ad813e3fef9cf178eeec4f8b9a204c4c33d /Lua API.html
parent61245711f7840a4d3c36739d5842180b95995136 (diff)
downloaddfhack-0c2b78b96b0aca46988f9d1e3c94f70cdfbc8e02.tar.gz
dfhack-0c2b78b96b0aca46988f9d1e3c94f70cdfbc8e02.tar.bz2
dfhack-0c2b78b96b0aca46988f9d1e3c94f70cdfbc8e02.tar.xz
Add api for manipulating burrows to the core.
Diffstat (limited to 'Lua API.html')
-rw-r--r--Lua API.html24
1 files changed, 24 insertions, 0 deletions
diff --git a/Lua API.html b/Lua API.html
index 0f5f18de..0ca88966 100644
--- a/Lua API.html
+++ b/Lua API.html
@@ -917,6 +917,12 @@ a lua list containing them.</p>
<li><p class="first"><tt class="docutils literal">dfhack.units.isSane(unit)</tt></p>
<p>The unit is capable of rational action, i.e. not dead, insane or zombie.</p>
</li>
+<li><p class="first"><tt class="docutils literal">dfhack.units.isInBurrow(unit,burrow)</tt></p>
+<p>Checks if the unit is in the burrow.</p>
+</li>
+<li><p class="first"><tt class="docutils literal">dfhack.units.setInBurrow(unit,burrow,enable)</tt></p>
+<p>Adds or removes the unit from the burrow.</p>
+</li>
</ul>
</div>
<div class="section" id="maps-module">
@@ -943,6 +949,24 @@ a lua list containing them.</p>
<li><p class="first"><tt class="docutils literal">dfhack.maps.getLocalInitFeature(region_coord2d,index)</tt></p>
<p>Returns the local feature object with the given region coords and index.</p>
</li>
+<li><p class="first"><tt class="docutils literal">dfhack.maps.findBurrowByName(name)</tt></p>
+<p>Returns the burrow pointer or <em>nil</em>.</p>
+</li>
+<li><p class="first"><tt class="docutils literal">dfhack.maps.listBurrowBlocks(burrow)</tt></p>
+<p>Returns a table of map block pointers.</p>
+</li>
+<li><p class="first"><tt class="docutils literal">dfhack.maps.isBurrowTile(burrow,tile_coord)</tt></p>
+<p>Checks if the tile is in burrow.</p>
+</li>
+<li><p class="first"><tt class="docutils literal">dfhack.maps.setBurrowTile(burrow,tile_coord,enable)</tt></p>
+<p>Adds or removes the tile from the burrow. Returns <em>false</em> if invalid coords.</p>
+</li>
+<li><p class="first"><tt class="docutils literal">dfhack.maps.isBlockBurrowTile(burrow,block,x,y)</tt></p>
+<p>Checks if the tile within the block is in burrow.</p>
+</li>
+<li><p class="first"><tt class="docutils literal">dfhack.maps.setBlockBurrowTile(burrow,block,x,y,enable)</tt></p>
+<p>Adds or removes the tile from the burrow. Returns <em>false</em> if invalid coords.</p>
+</li>
</ul>
</div>
</div>