isOverlayVisible

From RPTools Wiki
Jump to navigation Jump to search

isOverlayVisible() Function

• Introduced in version 1.11.0
Checks the visible status of an Overlay as seen in the Windows -> Overlay menu and returns a 1 or 0.

Usage

isOverlayVisible(name)

Parameters

  • name - Overlay name

Example

Check if an overlay is visible. 
[overlay("MyOverlay"):{<h2>This is an overlay.</h2>}]
Overlay is visible: [r: if(isOverlayVisible("MyOverlay"),"True","False")]

Returns:

1 or 0

See Also

setOverlayVisible()

Version Changes

  • 1.11.0 - Function added
Retrieved from "https://rptools.hyperbooks.com/index.php?title=isOverlayVisible&oldid=35179"