From dd3ff7252d39e1bf3376d7bf3f5610be5e58a05f Mon Sep 17 00:00:00 2001 From: Myk Taylor Date: Sat, 15 Aug 2020 17:26:38 -0700 Subject: [PATCH] document additional parameter to checkFreeTiles --- docs/Lua API.rst | 3 ++- 1 file changed, 2 insertions(+), 1 deletion(-) diff --git a/docs/Lua API.rst b/docs/Lua API.rst index 45ccd46a9..28b90f0d0 100644 --- a/docs/Lua API.rst +++ b/docs/Lua API.rst @@ -1617,11 +1617,12 @@ General using width and height for flexible dimensions. 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, 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. + Set ``is_civzone`` to true if the building is a civzone (like an activity zone). * ``dfhack.buildings.countExtentTiles(extents,defval)``