getMBL: Difference between revisions
Jump to navigation
Jump to search
m (Undo revision 11255 by Kwvanderlinde (talk)) Tag: Undo |
(First parameter can accept one or multiple shapes; second parameter is optional; fix example code to use valid JSON.) |
||
| Line 10: | Line 10: | ||
|usage= | |usage= | ||
<source lang="mtmacro" line> | <source lang="mtmacro" line> | ||
getMBL(shape) | |||
getMBL(shape,format) | getMBL(shape,format) | ||
</source> | </source> | ||
This function retrieves the MBL found in the given shape. | This function retrieves the MBL found in the given shape(s). | ||
'''Parameters''' | '''Parameters''' | ||
{{param|shape|A JSON object as described in {{func|drawMBL}}.}} | {{param|shape|A JSON object or array of JSON objects, as described in {{func|drawMBL}}. If an array, gets all the MBL within all provided shapes, otherwise just the MBL in the single provided shape.}} | ||
{{param|format|Boolean. Returns a JSON object if {{false}}, or | {{param|format|OPTIONAL Boolean. Returns a JSON object if {{false}}, or a JSON array of coordinates if {{true}}. In either case, the returned shape covers the MBL found in the area. Defaults to {{false}}}} | ||
|examples= | |||
[h:rectangle = " | <source lang="mtmacro"> | ||
[h:rectangle = '{"shape":"rectangle","x":50,"y":50,"w":100,"h":200,"r":45,"fill":1,"thickness":1,"scale":0}'] | |||
[r:mblData = getMBL(rectangle , 0)] | [r:mblData = getMBL(rectangle , 0)] | ||
</source><br /> | </source><br /> | ||
Revision as of 14:42, 12 October 2021
This article is a stub, you can help the RPTools Wiki project by contributing content to expand this article.
getMBL() Function
Note: This function can only be used in a Trusted Macro
• Introduced in version 1.9.0
Gets the Movement Blocking Layer (MBL) shapes for the area specified in the
shape parameter.Usage
getMBL(shape)
getMBL(shape,format)This function retrieves the MBL found in the given shape(s).
Parameters
shape- A JSON object or array of JSON objects, as described in drawMBL(). If an array, gets all the MBL within all provided shapes, otherwise just the MBL in the single provided shape.format- OPTIONAL Boolean. Returns a JSON object iffalse(0), or a JSON array of coordinates iftrue(1). In either case, the returned shape covers the MBL found in the area. Defaults tofalse(0)
Examples
[h:rectangle = '{"shape":"rectangle","x":50,"y":50,"w":100,"h":200,"r":45,"fill":1,"thickness":1,"scale":0}']
[r:mblData = getMBL(rectangle , 0)]