overlay (roll option): Difference between revisions

From RPTools Wiki
Jump to navigation Jump to search
No edit summary
mNo edit summary
Line 2: Line 2:
|name=overlay
|name=overlay
|version=1.7.0
|version=1.7.0
|description=[[Image:overlay_example.png|thumb|right|Selected units have health bars rendered in the top left in an overlay.]] Places a transparent HTML5 overlay over the map view. Players can click through the overlay to affect the map as normal, but clickable effects on the overlay will work as intended. Using HTML5, CSS, and JavaScript, overlays enable graphical user interfaces akin to Diablo and WoW right in MapTool.
|description=[[Image:overlay_example.png|thumb|An overlay showing selected units' health bars in the top left.]] Places a transparent HTML5 overlay over the map view. Players can click through the overlay to affect the map as normal, but clickable effects on the overlay will work as intended. Using HTML5, CSS, and JavaScript, overlays enable graphical user interfaces akin to Diablo and WoW right in MapTool.


Because overlays can't be closed like a frame or a dialog, users can instead toggle them on or off in the {{ui location|Window > Overlays}} menu.
Because overlays can't be closed like a frame or a dialog, users can instead toggle them on or off in the {{ui location|Window > Overlays}} menu.

Revision as of 22:51, 12 May 2020

[overlay():] Roll Option

* Introduced in version 1.7.0
File:overlay example.png
An overlay showing selected units' health bars in the top left.

Places a transparent HTML5 overlay over the map view. Players can click through the overlay to affect the map as normal, but clickable effects on the overlay will work as intended. Using HTML5, CSS, and JavaScript, overlays enable graphical user interfaces akin to Diablo and WoW right in MapTool.

Because overlays can't be closed like a frame or a dialog, users can instead toggle them on or off in the Window > Overlays menu.

Usage

[overlay(overlayName): { ... }]

The title parameter overlayName, should be a string that specifies the internal name of the overlay. It is also the name of the overlay as it will appear in Window > Overlays menu.

Examples

The following code simply prints 'Hello World' in large white letters at the top left of the map view:

[overlay("MyOverlay"): { <h1 style='color:white;'>Hello, World!</h1> }]

See Also

[frame():]
[frame5():]
[dialog():]
[dialog5():]
Whitelisted CDNs

Version Changes

  • 1.7.0 - Introduced.