closeOverlay: Difference between revisions

From RPTools Wiki
Jump to navigation Jump to search
m (Text replacement - "source>" to "syntaxhighlight>")
m (Text replacement - "<source" to "<syntaxhighlight")
Line 8: Line 8:


|usage=
|usage=
<source lang="mtmacro" line>
<syntaxhighlight lang="mtmacro" line>
[h: closeOverlay(name)]
[h: closeOverlay(name)]
</syntaxhighlight>
</syntaxhighlight>
}}
}}
[[Category:Overlay Function]]
[[Category:Overlay Function]]

Revision as of 17:29, 14 March 2023

 This article is a stub, you can help the RPTools Wiki project by contributing content to expand this article.

closeOverlay() Function

Introduced in version 1.7.0
Closes/deregisters the specified overlay that was previously created using [overlay():]. If the overlay is not registered then the function has no effect. Note that while each connected client can hide any overlay from the Window > Overlays menu, they still run in the background unless you use this function to close them.

Usage

[h: closeOverlay(name)]