getVBL

 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 Vision Blocking Layer (VBL) shapes for the area specified in the shape parameter.

Usage

getVBL(shape,format)

This function retrieves the VBL found in the given shape.

Parameters

• shape - A JSON object as described in drawVBL().
• format - Boolean. Returns a JSON object if false(0), or an JSON array of coordinates if true(1). In either case, the returned shape covers the VBL found in the area.

Example:

[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)]

See Also

Introduction to Vision Blocking, eraseVBL(), drawVBL()