MetzNet
/
dfhack
3
0
Fork 0
Code Issues Pull Requests Packages Projects Releases Wiki Activity

document additional parameter to checkFreeTiles

develop
Myk Taylor 2020-08-15 17:26:38 -07:00
parent ae872e812f
commit dd3ff7252d
1 changed files with 2 additions and 1 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

3
docs/Lua API.rst
Unescape Escape View File

@ -1617,11 +1617,12 @@ General
using width and height for flexible dimensions. using width and height for flexible dimensions.
Returns *is_flexible, width, height, center_x, center_y*. Returns *is_flexible, width, height, center_x, center_y*.
* ``dfhack.buildings.checkFreeTiles(pos,size[,extents,change_extents,allow_occupied])`` * ``dfhack.buildings.checkFreeTiles(pos,size[,extents,change_extents,allow_occupied,is_civzone])``
Checks if the rectangle defined by ``pos`` and ``size``, and possibly extents, Checks if the rectangle defined by ``pos`` and ``size``, and possibly extents,
can be used for placing a building. If ``change_extents`` is true, bad tiles can be used for placing a building. If ``change_extents`` is true, bad tiles
are removed from extents. If ``allow_occupied``, the occupancy test is skipped. are removed from extents. If ``allow_occupied``, the occupancy test is skipped.
Set ``is_civzone`` to true if the building is a civzone (like an activity zone).
* ``dfhack.buildings.countExtentTiles(extents,defval)`` * ``dfhack.buildings.countExtentTiles(extents,defval)``