getFrameProperties

From RPTools Wiki
Revision as of 09:18, 20 August 2019 by Merudo (talk | contribs)
Jump to navigationJump to search

 This article is a stub, you can help the RPTools Wiki project by contributing content to expand this article.

getFrameProperties() Function

Introduced in version 1.5.4
Returns a json object holding the properties associated with a given frame. The properties are width, height, temporary, title, and value.

Usage

getFrameProperties(name)

Parameters

  • name - The name of the frame.

Example

Opening up a frame
[frame("Frame Test", "width=300; height=200; temporary=0; title=A new title; value=data of relevance"): {test}]

Getting the properties of the frame:

[getFrameProperties("Frame Test")]

The output will be:

 {"width":300,"height":200,"temporary":0,"title":"A new title","value":"data of relevance"}