Skip to content

Commit ba44894

Browse files
committed
update docs for checkFreeTiles
1 parent 768e3f2 commit ba44894

File tree

2 files changed

+11
-8
lines changed

2 files changed

+11
-8
lines changed

docs/changelog.txt

Lines changed: 2 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -74,11 +74,13 @@ Template for new versions:
7474

7575
## API
7676
- ``Military::removeFromSquad``: removes unit from any squad assignments
77+
- ``Buildings::checkFreeTiles``: now replaces the extents parameter for a building pointer
7778

7879
## Lua
7980
- ``dfhack.units.setAutomaticProfessions``: sets unit labors according to current work detail settings
8081
- ``dfhack.military.removeFromSquad``: Lua API for ``Military::removeFromSquad``
8182
- ``gui.dwarfmode``: adventure mode cursor now supported in ``getCursorPos``, ``setCursorPos``, and ``clearCursorPos`` funcitons
83+
- ``dfhack.buildings.checkFreeTiles``: now replaces the extents parameter for a building pointer
8284

8385
## Removed
8486

docs/dev/Lua API.rst

Lines changed: 9 additions & 8 deletions
Original file line numberDiff line numberDiff line change
@@ -2477,14 +2477,15 @@ General
24772477
using width and height for flexible dimensions.
24782478
Returns *is_flexible, width, height, center_x, center_y*.
24792479

2480-
* ``dfhack.buildings.checkFreeTiles(pos,size[,extents[,change_extents[,allow_occupied[,allow_wall[,allow_flow]]]]])``
2481-
2482-
Checks if the rectangle defined by ``pos`` and ``size``, and possibly extents,
2483-
can be used for placing a building. If ``change_extents`` is true, bad tiles
2484-
are removed from extents. If ``allow_occupied``, the occupancy test is skipped.
2485-
Set ``allow_wall`` to true if the building is unhindered by walls (such as an
2486-
activity zone). Set ``allow_flow`` to true if the building can be built even
2487-
if there is deep water or any magma on the tile (such as abstract buildings).
2480+
* ``dfhack.buildings.checkFreeTiles(pos,size[,bld[,change_extents[,allow_occupied[,allow_wall[,allow_flow]]]]])``
2481+
2482+
Checks if the rectangle defined by ``pos`` and ``size``, and possibly the
2483+
extents associated with bld, can be used for placing a building. If
2484+
``change_extents`` is true, bad tiles are removed from extents. If
2485+
``allow_occupied``, the occupancy test is skipped. Set ``allow_wall`` to true
2486+
if the building is unhindered by walls (such as an activity zone). Set
2487+
``allow_flow`` to true if the building can be built even if there is deep
2488+
water or any magma on the tile (such as abstract buildings).
24882489

24892490
* ``dfhack.buildings.countExtentTiles(extents,defval)``
24902491

0 commit comments

Comments
 (0)