getCoverVBL

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

getCoverVBL() Function

 Note: This function can only be used in a Trusted Macro

• Introduced in version 1.15.0

Gets the Cover Vision Blocking Layer (Cover VBL) shapes for the area specified in the shape parameter.

Usage

getCoverVBL(shape)
getCoverVBL(shape,format)

This function retrieves the Cover 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 Cover VBL within all provided shapes, otherwise just the Cover VBL in the single provided shape.
• format - OPTIONAL Boolean. Returns a JSON object if false(0), or a JSON array of coordinates if true(1). In either case, the returned shape covers the Cover VBL found in the area. Defaults to false(0)

Examples

[h:rectangle = '{"shape":"rectangle","x":50,"y":50,"w":100,"h":200,"r":45,"fill":1,"thickness":1,"scale":0}']
[r:vblData   = getCoverVBL(rectangle , 0)]

See Also

Introduction to Vision Blocking, eraseCoverVBL(), drawCoverVBL()