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

update docs

develop
Myk Taylor 2023-01-27 13:39:03 -08:00
parent f700ef90b8
commit b492d92748
No known key found for this signature in database
GPG Key ID: 8A39CA0FA0C16E78
2 changed files with 13 additions and 3 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

3
docs/changelog.txt
Unescape Escape View File

@ -36,7 +36,7 @@ changelog.txt uses a syntax similar to RST, with a few special sequences:
## New Plugins ## New Plugins
## Fixes ## Fixes
- Fix issues with clicks "passing through" some DFHack window elements, like scrollbars -@ Fix issues with clicks "passing through" some DFHack window elements, like scrollbars
## Misc Improvements ## Misc Improvements
- A new cross-compile build script was added for building the Windows files from a Linux Docker builder (see the Compile instructions in the docs) - A new cross-compile build script was added for building the Windows files from a Linux Docker builder (see the Compile instructions in the docs)
@ -50,6 +50,7 @@ changelog.txt uses a syntax similar to RST, with a few special sequences:
## Documentation ## Documentation
## API ## API
- ``Buildings::containsTile()``: no longer takes a ``room`` parameter since that's not how rooms work anymore. If the building has extents, the extents will be checked. otherwise, the result just depends on whether the tile is within the building's bounding box.
## Lua ## Lua
- `helpdb`: new function: ``helpdb.refresh()`` to force a refresh of the database. Call if you are a developer adding new scripts, loading new plugins, or changing help text during play - `helpdb`: new function: ``helpdb.refresh()`` to force a refresh of the database. Call if you are a developer adding new scripts, loading new plugins, or changing help text during play

13
docs/dev/Lua API.rst
Unescape Escape View File

@ -1933,9 +1933,11 @@ General
Returns the number of tiles included by extents, or defval. Returns the number of tiles included by extents, or defval.
* ``dfhack.buildings.containsTile(building, x, y[, room])`` * ``dfhack.buildings.containsTile(building, x, y)``
Checks if the building contains the specified tile, either directly, or as room. Checks if the building contains the specified tile. If the building contains extents,
then the extents are checked. Otherwise, returns whether the x and y map coordinates
are within the building's bounding box.
* ``dfhack.buildings.hasSupport(pos,size)`` * ``dfhack.buildings.hasSupport(pos,size)``
@ -5603,6 +5605,13 @@ sort
The `sort <sort>` plugin does not export any native functions as of now. The `sort <sort>` plugin does not export any native functions as of now.
Instead, it calls Lua code to perform the actual ordering of list items. Instead, it calls Lua code to perform the actual ordering of list items.
tiletypes
=========
* ``bool tiletypes_setTile(pos, shape, material, special, variant)`` where
the parameters are enum values from ``df.tiletype_shape``,
``df.tiletype_material``, etc. Returns whether the conversion succeeded.
.. _xlsxreader-api: .. _xlsxreader-api:
xlsxreader xlsxreader