getOverlayProperties: Difference between revisions

From RPTools Wiki
Jump to navigation Jump to search
mNo edit summary
m (Conversion script moved page getOverlayProperties to GetOverlayProperties without leaving a redirect: Converting page title to first-letter uppercase)
(No difference)

Revision as of 22:35, 9 February 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}