getDialogProperties: Difference between revisions
Jump to navigation
Jump to search
m (Conversion script moved page getDialogProperties to GetDialogProperties without leaving a redirect: Converting page title to first-letter uppercase) |
m (Text replacement - "<source" to "<syntaxhighlight") |
||
| (3 intermediate revisions by 2 users not shown) | |||
| Line 7: | Line 7: | ||
|usage= | |usage= | ||
< | <syntaxhighlight lang="mtmacro" line> | ||
getDialogProperties(name) | getDialogProperties(name) | ||
</ | </syntaxhighlight> | ||
'''Parameters''' | '''Parameters''' | ||
| Line 16: | Line 16: | ||
|example= | |example= | ||
Opening up a dialog | Opening up a dialog | ||
< | <syntaxhighlight 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: | ||
< | <syntaxhighlight lang="mtmacro" line> | ||
[getDialogProperties("Dialog Test")] | [getDialogProperties("Dialog Test")] | ||
</ | </syntaxhighlight> | ||
The output will be: | The output will be: | ||
< | <syntaxhighlight 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]] | ||
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.
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
getDialogProperties(name)Parameters
name- The name of the dialog.
Example
Opening up a dialog
[dialog("Dialog Test", "width=300; height=200; temporary=0; title=A new title; value=data of relevance"): {test}]Getting the properties of the dialog:
[getDialogProperties("Dialog Test")]The output will be:
{"width":300,"height":200,"temporary":0,"title":"A new title","value":"data of relevance"}