eraseVBL: Difference between revisions

From RPTools Wiki
Jump to navigation Jump to search
No edit summary
(Changing function category)
Line 26: Line 26:
[[Introduction to Vision Blocking]], {{func|drawVBL}}
[[Introduction to Vision Blocking]], {{func|drawVBL}}
}}
}}
[[Category:Token Function]]
[[Category:Miscellaneous Function]]

Revision as of 20:33, 10 April 2013

eraseVBL() Function

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

Introduced in version 1.3b89
This function erases Vision Blocking Layer (VBL) shapes.

Usage

eraseVBL(shapesList)

This function works EXACTLY the same as drawVBL() with the ONLY difference that drawVBL() draws the shapes on the vision blocking layer and eraseVBL erases them. For descriptions on parameters and more examples goto the drawVBL() page.

Example

This example erases a (solid) block of VBL of 200x200 pixels, centered on 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:eraseVBL(objectArrary)]

See Also