closeOverlay: Difference between revisions

From RPTools Wiki
Jump to navigation Jump to search
(Created page with "{{MacroFunction |name=closeOverlay |version=1.7.0 |description=Closes/deregisters the specified overlay that was previously created using {{roll|overlay}}. If the overlay is n...")
 
m (Text replacement - "<source" to "<syntaxhighlight")
 
(5 intermediate revisions by 3 users not shown)
Line 1: Line 1:
{{stub}}
{{MacroFunction
{{MacroFunction
|name=closeOverlay
|name=closeOverlay
Line 7: Line 8:


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

Latest revision as of 23:59, 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)]