getHillVBL: Difference between revisions
Jump to navigation
Jump to search
(Created page with "{{stub}} {{MacroFunction |name=getHillVBL |proposed=false |trusted=true |version=1.11.0 |description= Gets the Hill Vision Blocking Layer (Hill VBL) shapes for the area specif...") |
m (Conversion script moved page getHillVBL to GetHillVBL without leaving a redirect: Converting page title to first-letter uppercase) |
(No difference)
| |
Revision as of 22:40, 9 February 2023
This article is a stub, you can help the RPTools Wiki project by contributing content to expand this article.
getHillVBL() Function
Note: This function can only be used in a Trusted Macro
• Introduced in version 1.11.0
Gets the Hill Vision Blocking Layer (Hill VBL) shapes for the area specified in the
shape parameter.Usage
getHillVBL(shape)
getHillVBL(shape,format)This function retrieves the Hill VBL found in the given shape(s).
Parameters
shape- A JSON object, or an array of JSON objects, as described in drawVBL(). If an array, gets all the Hill VBL within all provided shapes, otherwise just the Hill VBL 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 Hill VBL 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:vblData = getHillVBL(rectangle , 0)]