Update Lua API.rst

Document autoDFAnnouncement, pauseRecenter, and recenterViewscreen.
develop
Ryan Williams 2022-04-25 00:02:37 -07:00 committed by GitHub
parent 861a0ee85e
commit c66448015e
No known key found for this signature in database
GPG Key ID: 4AEE18F83AFDEB23
1 changed files with 24 additions and 0 deletions

@ -1004,6 +1004,22 @@ Fortress mode
Resets the fortress mode sidebar menus and cursors to their default state. If Resets the fortress mode sidebar menus and cursors to their default state. If
``pause`` is true, also pauses the game. ``pause`` is true, also pauses the game.
* ``dfhack.gui.pauseRecenter(pos[,pause])
* ``dfhack.gui.pauseRecenter(x,y,z[,pause])
Same as ``resetDwarfmodeView``, but also recenter if ``x`` isn't ``-30000``,
and respects RECENTER_INTERFACE_SHUTDOWN_MS in DF's init.txt.
* ``dfhack.gui.recenterViewscreen(pos[,zoom])
* ``dfhack.gui.recenterViewscreen(x,y,z[,zoom])
* ``dfhack.gui.recenterViewscreen([zoom])
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``
(0 = Generic, 1 = Item, 2 = Unit), where Generic skips recentering and
enforces valid view bounds (the same as x = -30000.)
Default zoom type is Item.
* ``dfhack.gui.revealInDwarfmodeMap(pos)`` * ``dfhack.gui.revealInDwarfmodeMap(pos)``
Centers the view on the given position, which can be a ``df.coord`` instance Centers the view on the given position, which can be a ``df.coord`` instance
@ -1073,6 +1089,14 @@ Announcements
Uses the type to look up options from announcements.txt, and calls the above Uses the type to look up options from announcements.txt, and calls the above
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(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.
Sometimes this means the announcement won't occur. Set ``log_failures`` to ``true`` to
log the reason why to the dfhack console (e.g., unrevealed map or wrong gamemode.)
Can also be built from parameters instead of a ``report_init``.
Other Other
~~~~~ ~~~~~