getDialogProperties: Difference between revisions
Jump to navigation
Jump to search
m (Conversion script moved page GetDialogProperties to getDialogProperties: Converting page titles to lowercase) |
m (Text replacement - "source>" to "syntaxhighlight>") |
||
| Line 9: | Line 9: | ||
<source lang="mtmacro" line> | <source lang="mtmacro" line> | ||
getDialogProperties(name) | getDialogProperties(name) | ||
</ | </syntaxhighlight> | ||
'''Parameters''' | '''Parameters''' | ||
| Line 18: | Line 18: | ||
<source lang="mtmacro" line> | <source lang="mtmacro" line> | ||
[dialog("Dialog Test", "width=300; height=200; temporary=0; title=A new title; value=data of relevance"): {test}] | [dialog("Dialog Test", "width=300; height=200; temporary=0; title=A new title; value=data of relevance"): {test}] | ||
</ | </syntaxhighlight> | ||
Getting the properties of the dialog: | Getting the properties of the dialog: | ||
| Line 24: | Line 24: | ||
<source lang="mtmacro" line> | <source lang="mtmacro" line> | ||
[getDialogProperties("Dialog Test")] | [getDialogProperties("Dialog Test")] | ||
</ | </syntaxhighlight> | ||
The output will be: | The output will be: | ||
<source lang="mtmacro" line> | <source lang="mtmacro" line> | ||
{"width":300,"height":200,"temporary":0,"title":"A new title","value":"data of relevance"} | {"width":300,"height":200,"temporary":0,"title":"A new title","value":"data of relevance"} | ||
</ | </syntaxhighlight> | ||
}} | }} | ||
[[Category:Dialog Function]] | [[Category:Dialog Function]] | ||
Revision as of 18:27, 14 March 2023
This article is a stub, you can help the RPTools Wiki project by contributing content to expand this article.
getDialogProperties() Function
• Introduced in version 1.5.4
Returns a json object holding the properties associated with a given dialog. The properties are
width, height, temporary, title, and value.Usage
<source lang="mtmacro" line> getDialogProperties(name) </syntaxhighlight>
Parameters
name- The name of the dialog.
Example
Opening up a dialog
<source lang="mtmacro" line> [dialog("Dialog Test", "width=300; height=200; temporary=0; title=A new title; value=data of relevance"): {test}] </syntaxhighlight>
Getting the properties of the dialog:
<source lang="mtmacro" line> [getDialogProperties("Dialog Test")] </syntaxhighlight>
The output will be: <source lang="mtmacro" line>
{"width":300,"height":200,"temporary":0,"title":"A new title","value":"data of relevance"}
</syntaxhighlight>