From c89baa5e338c16ba3ea2cc4539e93d5b0d2db742 Mon Sep 17 00:00:00 2001 From: Ryan Williams Date: Thu, 28 Apr 2022 22:40:36 -0700 Subject: [PATCH] Update Lua API.rst --- docs/Lua API.rst | 12 ++++++------ 1 file changed, 6 insertions(+), 6 deletions(-) diff --git a/docs/Lua API.rst b/docs/Lua API.rst index 33d6b0a44..bad0481bb 100644 --- a/docs/Lua API.rst +++ b/docs/Lua API.rst @@ -1008,7 +1008,7 @@ Fortress mode ``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. + and respects RECENTER_INTERFACE_SHUTDOWN_MS (the delay before input is recognized when a recenter occurs) in DF's init.txt. * ``dfhack.gui.recenterViewscreen(pos[,zoom])`` ``dfhack.gui.recenterViewscreen(x,y,z[,zoom])`` @@ -1016,8 +1016,8 @@ Fortress mode 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.) + (0 = Generic, 1 = Item, 2 = Unit), where ``Generic`` skips recentering and + enforces valid view bounds (the same as x = -30000,) ``Item`` brings the position onscreen, and ``Unit`` centers the screen on the position. Default zoom type is Item. * ``dfhack.gui.revealInDwarfmodeMap(pos)`` @@ -1090,12 +1090,12 @@ Announcements 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])`` + ``dfhack.gui.autoDFAnnouncement(type,pos,text,color[,is_bright,unit1,unit2,not_sparring,log_failures])`` - Takes a ``df.report_init`` and a string and processes them just like DF does. + Takes a ``df.report_init`` (see: https://github.com/DFHack/df-structures/blob/master/df.announcements.xml#L451) 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``. + Can also be built from parameters instead of a ``report_init``. Setting ``not_sparring`` to ``false`` means it will be added to sparring logs (if applicable) rather than hunting or combat. Other ~~~~~