getOverlayProperties

 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

<source lang="mtmacro" line> getOverlayProperties(name) </syntaxhighlight>

Parameters

• name - The name of the overlay.

Example

Opening up an overlay

<source lang="mtmacro" line> [overlay("Test Overlay", "zorder=100;"): {test}] </syntaxhighlight>

Getting the properties of the overlay:

<source lang="mtmacro" line> [getOverlayProperties("Test Overlay")] </syntaxhighlight>

The output will be: <source lang="mtmacro" line>

{"name":"Test Overlay","zorder":100,"visible":1}

</syntaxhighlight>