getOverlayProperties: Difference between revisions
Jump to navigation
Jump to search
m (Conversion script moved page getOverlayProperties to GetOverlayProperties without leaving a redirect: Converting page title to first-letter uppercase) |
m (Text replacement - "<source" to "<syntaxhighlight") |
||
| (2 intermediate revisions by 2 users not shown) | |||
| Line 7: | Line 7: | ||
|usage= | |usage= | ||
< | <syntaxhighlight lang="mtmacro" line> | ||
getOverlayProperties(name) | getOverlayProperties(name) | ||
</ | </syntaxhighlight> | ||
'''Parameters''' | '''Parameters''' | ||
| Line 16: | Line 16: | ||
|example= | |example= | ||
Opening up an overlay | Opening up an overlay | ||
< | <syntaxhighlight lang="mtmacro" line> | ||
[overlay("Test Overlay", "zorder=100;"): {test}] | [overlay("Test Overlay", "zorder=100;"): {test}] | ||
</ | </syntaxhighlight> | ||
Getting the properties of the overlay: | Getting the properties of the overlay: | ||
< | <syntaxhighlight lang="mtmacro" line> | ||
[getOverlayProperties("Test Overlay")] | [getOverlayProperties("Test Overlay")] | ||
</ | </syntaxhighlight> | ||
The output will be: | The output will be: | ||
< | <syntaxhighlight lang="mtmacro" line> | ||
{"name":"Test Overlay","zorder":100,"visible":1} | {"name":"Test Overlay","zorder":100,"visible":1} | ||
</ | </syntaxhighlight> | ||
}} | }} | ||
[[Category:Overlay Function]] | [[Category:Overlay Function]] | ||
Latest revision as of 21:01, 14 March 2023
This article is a stub, you can help the RPTools Wiki project by contributing content to expand this article.
getOverlayProperties() Function
• Introduced in version 1.7.0
Returns a json object holding the properties associated with a given overlay. The properties are
name, zorder, and visible.Usage
getOverlayProperties(name)Parameters
name- The name of the overlay.
Example
Opening up an overlay
[overlay("Test Overlay", "zorder=100;"): {test}]Getting the properties of the overlay:
[getOverlayProperties("Test Overlay")]The output will be:
{"name":"Test Overlay","zorder":100,"visible":1}