getVBL
Jump to navigation
Jump to search
This article is a stub, you can help the RPTools Wiki project by contributing content to expand this article.
getVBL() Function
Note: This function can only be used in a Trusted Macro
• Introduced in version 1.3b90
Gets the Wall Vision Blocking Layer (Wall VBL) shapes for the area specified in the
shape
parameter.Usage
getVBL(shape)
getVBL(shape,format)
This function retrieves the Wall 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 Wall VBL within all provided shapes, otherwise just the Wall 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 Wall 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 = getVBL(rectangle , 0)]