Update API docs (#1607)

develop
lethosor 2020-07-17 17:35:09 -04:00
parent 35d659091d
commit 0cc6f40bd6
No known key found for this signature in database
GPG Key ID: 76A269552F4F58C1
2 changed files with 8 additions and 0 deletions

@ -2093,6 +2093,11 @@ unless otherwise noted.
Creates a new directory. Returns ``false`` if unsuccessful, including if ``path`` already exists. Creates a new directory. Returns ``false`` if unsuccessful, including if ``path`` already exists.
* ``dfhack.filesystem.mkdir_recursive(path)``
Creates a new directory, including any intermediate directories that don't exist yet.
Returns ``true`` if the folder was created or already existed, or ``false`` if unsuccessful.
* ``dfhack.filesystem.rmdir(path)`` * ``dfhack.filesystem.rmdir(path)``
Removes a directory. Only works if the directory is already empty. Removes a directory. Only works if the directory is already empty.

@ -50,6 +50,9 @@ changelog.txt uses a syntax similar to RST, with a few special sequences:
- `blueprint`: now automatically creates folder trees when organizing blueprints into subfolders (e.g. ``blueprint 30 30 1 rooms/dining dig`` will create the file ``blueprints/rooms/dining-dig.csv``); previously it would fail if the ``blueprints/rooms/`` directory didn't already exist - `blueprint`: now automatically creates folder trees when organizing blueprints into subfolders (e.g. ``blueprint 30 30 1 rooms/dining dig`` will create the file ``blueprints/rooms/dining-dig.csv``); previously it would fail if the ``blueprints/rooms/`` directory didn't already exist
- `confirm`: added a confirmation dialog for convicting dwarves of crimes - `confirm`: added a confirmation dialog for convicting dwarves of crimes
## API
- Added ``Filesystem::mkdir_recursive``
## Lua ## Lua
- Added a ``ref_target`` field to primitive field references, corresponding to the ``ref-target`` XML attribute - Added a ``ref_target`` field to primitive field references, corresponding to the ``ref-target`` XML attribute