eraseHillVBL: Difference between revisions

From RPTools Wiki
Jump to navigation Jump to search
(Created page with "{{MacroFunction |name=eraseHillVBL |proposed=false |trusted=true |version=1.11.0 |description= Erases Hill Vision Blocking Layer (Hill VBL) shapes from the '''Map''' VBL. Thi...")
 
m (Conversion script moved page eraseHillVBL to EraseHillVBL without leaving a redirect: Converting page title to first-letter uppercase)
(No difference)

Revision as of 22:40, 9 February 2023

eraseHillVBL() Function

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

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

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

Usage

eraseHillVBL(shapeArray)

Parameters

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

Example

This example erases a (solid) block of Hill 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:eraseHillVBL(objectArrary)]

See Also