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

Update Lua API.rst

develop
lethosor 2015-10-17 15:45:49 -04:00
parent 5387c03ea0
commit 9ebaa4d695
1 changed files with 17 additions and 6 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

23
docs/Lua API.rst
Unescape Escape View File

@ -789,11 +789,12 @@ can be omitted.
Returns the DF version string from ``symbols.xml``. Returns the DF version string from ``symbols.xml``.
* ``getDFHackVersion()`` * ``dfhack.getDFHackVersion()``
* ``getDFHackRelease()`` * ``dfhack.getDFHackRelease()``
* ``getCompiledDFVersion()`` * ``dfhack.getCompiledDFVersion()``
* ``getGitDescription()`` * ``dfhack.getGitDescription()``
* ``getGitCommit()`` * ``dfhack.getGitCommit()``
* ``dfhack.isRelease()``
Return information about the DFHack build in use. Return information about the DFHack build in use.
@ -835,10 +836,20 @@ can be omitted.
Convert a string from DF's CP437 encoding to UTF-8. Convert a string from DF's CP437 encoding to UTF-8.
* ``dfhack.df2console()``
Convert a string from DF's CP437 encoding to the correct encoding for the
DFHack console.
* ``dfhack.utf2df(string)`` * ``dfhack.utf2df(string)``
Convert a string from UTF-8 to DF's CP437 encoding. Convert a string from UTF-8 to DF's CP437 encoding.
**Note:** When printing CP437-encoded text to the console (for example, names
returned from TranslateName()), use ``print(dfhack.df2console(text)`` to ensure
proper display on all platforms.
Gui module Gui module
---------- ----------
@ -860,7 +871,7 @@ Gui module
Returns the topmost viewscreen out of the top ``depth`` viewscreens with Returns the topmost viewscreen out of the top ``depth`` viewscreens with
the specified type (e.g. ``df.viewscreen_titlest``), or ``nil`` if none match. the specified type (e.g. ``df.viewscreen_titlest``), or ``nil`` if none match.
If ``limit`` is not specified or is less than 1, all viewscreens are checked. If ``depth`` is not specified or is less than 1, all viewscreens are checked.
* ``dfhack.gui.getSelectedWorkshopJob([silent])`` * ``dfhack.gui.getSelectedWorkshopJob([silent])``