add docs for dfhack.gui.getMousePos()

develop
Myk Taylor 2022-09-18 13:31:20 -07:00
parent 28b70eaee9
commit 8e718d9851
No known key found for this signature in database
1 changed files with 5 additions and 0 deletions

@ -1088,6 +1088,11 @@ Announcements
Uses the type to look up options from announcements.txt, and calls the above
operations accordingly. The units are used to call ``addCombatReportAuto``.
* ``dfhack.gui.getMousePos()``
Returns the map coordinates of the map tile the mouse is over as a table of
``{x, y, z}``. If the cursor is not over the map, returns ``nil``.
Other
~~~~~