isOverlayVisible

From RPTools Wiki
Revision as of 13:41, 20 October 2021 by Phergus (talk | contribs) (Created page with "{{MacroFunction |name=isOverlayVisible |trusted=false |version=1.11.0 |description= Checks the visible status of an Overlay as seen in the Windows -> Overlay menu and returns...")
(diff) ← Older revision | Latest revision (diff) | Newer revision → (diff)
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, flag)

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=11613"