summaryrefslogtreecommitdiff
path: root/Lua API.html
diff options
context:
space:
mode:
authorAlexander Gavrilov2012-05-06 11:22:55 +0400
committerAlexander Gavrilov2012-05-06 11:22:55 +0400
commitb70130cf3684d8adbf36023b27aec0f10b213cc7 (patch)
tree945c51c426e963a868965b43441e3a99298f8e96 /Lua API.html
parent05e8083c8443ba604d0402b07824e4a05b86288c (diff)
downloaddfhack-b70130cf3684d8adbf36023b27aec0f10b213cc7.tar.gz
dfhack-b70130cf3684d8adbf36023b27aec0f10b213cc7.tar.bz2
dfhack-b70130cf3684d8adbf36023b27aec0f10b213cc7.tar.xz
Add a couple more building api functions.
Diffstat (limited to 'Lua API.html')
-rw-r--r--Lua API.html14
1 files changed, 11 insertions, 3 deletions
diff --git a/Lua API.html b/Lua API.html
index b96d1215..094b522c 100644
--- a/Lua API.html
+++ b/Lua API.html
@@ -1081,9 +1081,14 @@ burrows, or the presence of invaders.</p>
<li><p class="first"><tt class="docutils literal">dfhack.buildings.getSize(building)</tt></p>
<p>Returns <em>width, height, centerx, centery</em>.</p>
</li>
-<li><p class="first"><tt class="docutils literal">dfhack.buildings.findAtTile(pos)</tt></p>
+<li><p class="first"><tt class="docutils literal">dfhack.buildings.findAtTile(pos)</tt>, or <tt class="docutils literal">findAtTile(x,y,z)</tt></p>
<p>Scans the buildings for the one located at the given tile.
-Does not work on civzones. Warning: linear scan.</p>
+Does not work on civzones. Warning: linear scan if the map
+tile indicates there are buildings at it.</p>
+</li>
+<li><p class="first"><tt class="docutils literal">dfhack.buildings.findCivzonesAt(pos)</tt>, or <tt class="docutils literal">findCivzonesAt(x,y,z)</tt></p>
+<p>Scans civzones, and returns a lua sequence of those that touch
+the given tile, or <em>nil</em> if none.</p>
</li>
<li><p class="first"><tt class="docutils literal">dfhack.buildings.getCorrectSize(width, height, type, subtype, custom, direction)</tt></p>
<p>Computes correct dimensions for the specified building type and orientation,
@@ -1098,6 +1103,9 @@ are removed from extents. If <tt class="docutils literal">allow_occupied</tt>, t
<li><p class="first"><tt class="docutils literal">dfhack.buildings.countExtentTiles(extents,defval)</tt></p>
<p>Returns the number of tiles included by extents, or defval.</p>
</li>
+<li><p class="first"><tt class="docutils literal">dfhack.buildings.containsTile(building, x, y[, room])</tt></p>
+<p>Checks if the building contains the specified tile, either directly, or as room.</p>
+</li>
<li><p class="first"><tt class="docutils literal">dfhack.buildings.hasSupport(pos,size)</tt></p>
<p>Checks if a bridge constructed at specified position would have
support from terrain, and thus won't collapse if retracted.</p>
@@ -1113,7 +1121,7 @@ at specified position. Returns the object, or <em>nil</em> in case of an error.<
<p>Configures an object returned by <tt class="docutils literal">allocInstance</tt>, using specified
parameters wherever appropriate. If the building has fixed size along
any dimension, the corresponding input parameter will be ignored.
-Returns <em>nil</em> if the building cannot be placed, or <em>true, width,
+Returns <em>false</em> if the building cannot be placed, or <em>true, width,
height, rect_area, true_area</em>. Returned width and height are the
final values used by the building; true_area is less than rect_area
if any tiles were removed from designation.</p>