diff options
| author | Alexander Gavrilov | 2012-04-11 16:20:16 +0400 |
|---|---|---|
| committer | Alexander Gavrilov | 2012-04-11 16:20:16 +0400 |
| commit | 61245711f7840a4d3c36739d5842180b95995136 (patch) | |
| tree | 4524411ec53069d496e4ae11c011445de518f2de /Lua API.html | |
| parent | c7b922250b5e41cb78b8636a706fdc07be615974 (diff) | |
| download | dfhack-61245711f7840a4d3c36739d5842180b95995136.tar.gz dfhack-61245711f7840a4d3c36739d5842180b95995136.tar.bz2 dfhack-61245711f7840a4d3c36739d5842180b95995136.tar.xz | |
Export a few maps functions to lua.
Diffstat (limited to 'Lua API.html')
| -rw-r--r-- | Lua API.html | 27 |
1 files changed, 27 insertions, 0 deletions
diff --git a/Lua API.html b/Lua API.html index 89e15803..0f5f18de 100644 --- a/Lua API.html +++ b/Lua API.html @@ -340,6 +340,7 @@ ul.auto-toc { <li><a class="reference internal" href="#gui-module" id="id14">Gui module</a></li> <li><a class="reference internal" href="#job-module" id="id15">Job module</a></li> <li><a class="reference internal" href="#units-module" id="id16">Units module</a></li> +<li><a class="reference internal" href="#maps-module" id="id17">Maps module</a></li> </ul> </li> </ul> @@ -918,6 +919,32 @@ a lua list containing them.</p> </li> </ul> </div> +<div class="section" id="maps-module"> +<h3><a class="toc-backref" href="#id17">Maps module</a></h3> +<ul> +<li><p class="first"><tt class="docutils literal">dfhack.maps.getSize()</tt></p> +<p>Returns map size in blocks: <em>x, y, z</em></p> +</li> +<li><p class="first"><tt class="docutils literal">dfhack.maps.getTileSize()</tt></p> +<p>Returns map size in tiles: <em>x, y, z</em></p> +</li> +<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> +<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> +</li> +<li><p class="first"><tt class="docutils literal">dfhack.maps.getGlobalInitFeature(index)</tt></p> +<p>Returns the global feature object with the given index.</p> +</li> +<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> +</ul> +</div> </div> </div> </div> |
