Class engine.Tooltip
A generic tooltip
Methods
engine.Tooltip:set (str, ...)
Set the tooltip text
engine.Tooltip:displayAtMap (tmx, tmy, mx, my, text, force, nb_keyframes)
Displays the tooltip at the given map coordinates
engine.Tooltip:getTooltipAtMap (tmx, tmy, mx, my)
Gets the tooltips at the given map coord
Methods
- engine.Tooltip:set (str, ...)
-
Set the tooltip text
Parameters:
- str
- ... if locked change is forbiden
- engine.Tooltip:displayAtMap (tmx, tmy, mx, my, text, force, nb_keyframes)
-
Displays the tooltip at the given map coordinates
Parameters:
- tmx the map coordinate to get tooltip from
- tmy the map coordinate to get tooltip from
- mx the screen coordinate to display at, if nil it will be computed from tmx
- my the screen coordinate to display at, if nil it will be computed from tmy
- text a text to display, if nil it will interrogate the map under the mouse using the "tooltip" property
- force forces tooltip to refresh
- nb_keyframes number of keyframes
- engine.Tooltip:getTooltipAtMap (tmx, tmy, mx, my)
-
Gets the tooltips at the given map coord
Parameters:
- tmx
- tmy
- mx
- my