eraseVBL: Difference between revisions
Jump to navigation
Jump to search
No edit summary |
No edit summary |
||
| Line 10: | Line 10: | ||
|usage= | |usage= | ||
< | <syntaxhighlight lang="mtmacro" line> | ||
eraseVBL(shapeArray) | eraseVBL(shapeArray) | ||
</ | </syntaxhighlight> | ||
'''Parameters''' | '''Parameters''' | ||
{{param|shapeArray|An array of one or more shapes as JSON objects.}} | {{param|shapeArray|An array of one or more shapes as JSON objects.}} | ||
| Line 18: | Line 18: | ||
|example= | |example= | ||
This example erases a (solid) block of VBL of 200x200 pixels starting at the origin of the map | This example erases a (solid) block of VBL of 200x200 pixels starting at the origin of the map | ||
< | <syntaxhighlight lang="mtmacro" line> | ||
[h:rectangle = "{'shape':'rectangle','x':0,'y':0,'w':200,'h':200, 'fill':1}"] | [h:rectangle = "{'shape':'rectangle','x':0,'y':0,'w':200,'h':200, 'fill':1}"] | ||
[h:objectArrary = json.append('',rectangle)] | [h:objectArrary = json.append('',rectangle)] | ||
[h:eraseVBL(objectArrary)] | [h:eraseVBL(objectArrary)] | ||
</ | </syntaxhighlight> | ||
[[Category:VBL Function]] | [[Category:VBL Function]] | ||
Revision as of 11:50, 11 October 2020
eraseVBL() Function
Note: This function can only be used in a Trusted Macro
• Introduced in version 1.3b89
Erases Vision Blocking Layer (VBL) shapes from the Map VBL. This function does not affect Token VBL.
This function works the same as drawVBL() with the difference that drawVBL() draws the shapes on the Vision Blocking Layer and eraseVBL() erases them. For more examples go to the drawVBL() page.
Usage
eraseVBL(shapeArray)Parameters
shapeArray- An array of one or more shapes as JSON objects.
Example
This example erases a (solid) block of 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:eraseVBL(objectArrary)]