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

Update Lua API.rst 

Fix formatting (again)
develop
Ryan Williams 2022-04-25 00:10:26 -07:00 committed by GitHub
parent 709adda968
commit ad9a08f1e7
No known key found for this signature in database
GPG Key ID: 4AEE18F83AFDEB23
1 changed files with 4 additions and 4 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

8
docs/Lua API.rst
Unescape Escape View File

@ -1005,14 +1005,14 @@ Fortress mode
``pause`` is true, also pauses the game. ``pause`` is true, also pauses the game.
* ``dfhack.gui.pauseRecenter(pos[,pause])`` * ``dfhack.gui.pauseRecenter(pos[,pause])``
* ``dfhack.gui.pauseRecenter(x,y,z[,pause])`` ``dfhack.gui.pauseRecenter(x,y,z[,pause])``
Same as ``resetDwarfmodeView``, but also recenter if ``x`` isn't ``-30000``, Same as ``resetDwarfmodeView``, but also recenter if ``x`` isn't ``-30000``,
and respects RECENTER_INTERFACE_SHUTDOWN_MS in DF's init.txt. and respects RECENTER_INTERFACE_SHUTDOWN_MS in DF's init.txt.
* ``dfhack.gui.recenterViewscreen(pos[,zoom])`` * ``dfhack.gui.recenterViewscreen(pos[,zoom])``
* ``dfhack.gui.recenterViewscreen(x,y,z[,zoom])`` ``dfhack.gui.recenterViewscreen(x,y,z[,zoom])``
* ``dfhack.gui.recenterViewscreen([zoom])`` ``dfhack.gui.recenterViewscreen([zoom])``
Recenter the view on a position using a specific zoom type. If no position is Recenter the view on a position using a specific zoom type. If no position is
given, recenter on ``df.global.cursor``. Zoom types are ``df.report_zoom_type`` given, recenter on ``df.global.cursor``. Zoom types are ``df.report_zoom_type``
@ -1090,7 +1090,7 @@ Announcements
operations accordingly. The units are used to call ``addCombatReportAuto``. operations accordingly. The units are used to call ``addCombatReportAuto``.
* ``dfhack.gui.autoDFAnnouncement(report,text[,log_failures])`` * ``dfhack.gui.autoDFAnnouncement(report,text[,log_failures])``
* ``dfhack.gui.autoDFAnnouncement(type,pos,text,color[,is_bright,unit1,unit2,is_sparring,log_failures])`` ``dfhack.gui.autoDFAnnouncement(type,pos,text,color[,is_bright,unit1,unit2,is_sparring,log_failures])``
Takes a ``df.report_init`` and a string and processes them just like DF does. Takes a ``df.report_init`` and a string and processes them just like DF does.
Sometimes this means the announcement won't occur. Set ``log_failures`` to ``true`` to Sometimes this means the announcement won't occur. Set ``log_failures`` to ``true`` to