summaryrefslogtreecommitdiff
path: root/Lua API.html
diff options
context:
space:
mode:
authorAlexander Gavrilov2012-05-02 12:50:05 +0400
committerAlexander Gavrilov2012-05-02 12:50:05 +0400
commit28b5068382ebd406b269e6b4aeb073e7cd26503e (patch)
tree31f5ddd90b035e18857e645562b309040c84b559 /Lua API.html
parenteadce959408a7b1811bd158e4d5cb74e57b671e6 (diff)
downloaddfhack-28b5068382ebd406b269e6b4aeb073e7cd26503e.tar.gz
dfhack-28b5068382ebd406b269e6b4aeb073e7cd26503e.tar.bz2
dfhack-28b5068382ebd406b269e6b4aeb073e7cd26503e.tar.xz
Allow both coordinate object and (x,y,z) as arguments to getTileBlock.
Diffstat (limited to 'Lua API.html')
-rw-r--r--Lua API.html6
1 files changed, 3 insertions, 3 deletions
diff --git a/Lua API.html b/Lua API.html
index ebfbe80e..c7c2041d 100644
--- a/Lua API.html
+++ b/Lua API.html
@@ -1005,8 +1005,8 @@ Returns <em>false</em> in case of error.</p>
<li><p class="first"><tt class="docutils literal">dfhack.maps.getBlock(x,y,z)</tt></p>
<p>Returns a map block object for given x,y,z in local block coordinates.</p>
</li>
-<li><p class="first"><tt class="docutils literal">dfhack.maps.getTileBlock(coords)</tt></p>
-<p>Returns a map block object for given df::coord in local tile coordinates.</p>
+<li><p class="first"><tt class="docutils literal">dfhack.maps.getTileBlock(coords)</tt>, or <tt class="docutils literal">getTileBlock(x,y,z)</tt></p>
+<p>Returns a map block object for given df::coord or x,y,z in local tile coordinates.</p>
</li>
<li><p class="first"><tt class="docutils literal">dfhack.maps.getRegionBiome(region_coord2d)</tt></p>
<p>Returns the biome info struct for the given global map region.</p>
@@ -1129,7 +1129,7 @@ from the size of the building.</p>
<li><p class="first"><tt class="docutils literal">dfhack.constructions.designateNew(pos,type,item_type,mat_index)</tt></p>
<p>Designates a new construction at given position. If there already is
a planned but not completed construction there, changes its type.
-Returns <em>true</em> or <em>false</em> if obstructed.
+Returns <em>true</em>, or <em>false</em> if obstructed.
Note that designated constructions are technically buildings.</p>
</li>
</ul>