closeFrame: Difference between revisions

From RPTools Wiki
Jump to navigation Jump to search
(created)
 
No edit summary
 
(7 intermediate revisions by 5 users not shown)
Line 1: Line 1:
{{MacroFunction
{{MacroFunction
|name=closeFrame
|name=closeFrame
|version=1.3b70
|version=1.3b70
|description=Closes the specified macro frame that was previously created using {{roll|frame}}. If the  
|description=Closes the specified macro frame that was previously created using {{roll|frame}}. If the  
[[frame]] is not open then the function has no effect.  
frame is not open then the function has no effect.  


The most common use for this function is closing a [[frame]] based from a macro that is run when clicking on a link or button for the  
The most common use for this function is closing a frame based from a macro that is run when clicking on a link or button for the  
[[frame]] that has no close button.  
frame that has no close button.  


'''NOTE''' this function can not close dialogs opened with {{roll|dialog}}. Use {{func|closeDialog}} for that.
'''NOTE''' Frames created using '''temporary=0''' will not be removed and only made not visible. This function can not close dialogs opened with {{roll|dialog}}. Use {{func|closeDialog}} for that.


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

Latest revision as of 23:59, 16 November 2024

closeFrame() Function

Introduced in version 1.3b70
Closes the specified macro frame that was previously created using [frame():]. If the

frame is not open then the function has no effect.

The most common use for this function is closing a frame based from a macro that is run when clicking on a link or button for the frame that has no close button.

NOTE Frames created using temporary=0 will not be removed and only made not visible. This function can not close dialogs opened with [dialog():]. Use closeDialog() for that.

Usage

[h: closeFrame(name)]