eraseCoverVBL

From RPTools Wiki
Revision as of 02:05, 10 February 2024 by Cold Ankles (talk | contribs) (Added eraseCoverVBL)
(diff) ← Older revision | Latest revision (diff) | Newer revision → (diff)
Jump to navigation Jump to search

eraseCoverVBL() Function

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

Introduced in version 1.15.0
Erases Cover Vision Blocking Layer (Cover VBL) shapes from the Map VBL. This function does not affect Token VBL.

This function works the same as drawCoverVBL() with the difference that drawCoverVBL() draws the shapes on the Cover Vision Blocking Layer and eraseCoverVBL() erases them. For more examples go to the drawCoverVBL() page.

Usage

eraseCoverVBL(shapeArray)

Parameters

  • shapeArray - An array of one or more shapes as JSON objects.

Example

This example erases a (solid) block of Cover VBL of 200x200 pixels starting at the origin of the map
[h:rectangle	= "{'shape':'rectangle','x':0,'y':0,'w':200,'h':200, 'fill':1}"]
[h:objectArrary	= json.append('',rectangle)]
[h:eraseCoverVBL(objectArrary)]

See Also