isOverlayVisible: Difference between revisions

From RPTools Wiki
Jump to navigation Jump to search
(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...")
 
m (Conversion script moved page IsOverlayVisible to isOverlayVisible: Converting page titles to lowercase)
 
(2 intermediate revisions by 2 users not shown)
Line 8: Line 8:
|usage=
|usage=
<syntaxhighlight lang="mtmacro" line>
<syntaxhighlight lang="mtmacro" line>
isOverlayVisible(name, flag)
isOverlayVisible(name)
</syntaxhighlight>
</syntaxhighlight>
'''Parameters'''
'''Parameters'''

Latest revision as of 23:45, 9 February 2023

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

Version Changes

  • 1.11.0 - Function added