eraseVBL: Difference between revisions
Jump to navigation
Jump to search
(Modified usage, added link) |
|||
| (11 intermediate revisions by 6 users not shown) | |||
| Line 1: | Line 1: | ||
{{MacroFunction | {{MacroFunction | ||
|name=eraseVBL | |name=eraseVBL | ||
| Line 8: | Line 5: | ||
|version=1.3b89 | |version=1.3b89 | ||
|description= | |description= | ||
This function erases | Erases Wall Vision Blocking Layer (Wall VBL) shapes from the '''Map''' VBL. This function does not affect Token VBL. | ||
<p> | |||
This function works the same as {{func|drawVBL}} with the difference that {{func|drawVBL}} draws the shapes on the Vision Blocking Layer and {{func|eraseVBL}} erases them. For more examples go to the {{func|drawVBL}} page. | |||
|usage= | |usage= | ||
< | <syntaxhighlight lang="mtmacro" line> | ||
eraseVBL( | eraseVBL(shapeArray) | ||
</ | </syntaxhighlight> | ||
'''Parameters''' | |||
{{param|shapeArray|An array of one or more shapes as JSON objects.}} | |||
|example= | |example= | ||
This example | This example erases a (solid) block of VBL of 200x200 pixels starting at the origin of the map | ||
< | <syntaxhighlight lang="mtmacro" line> | ||
[h: | [h:rectangle = "{'shape':'rectangle','x':0,'y':0,'w':200,'h':200, 'fill':1}"] | ||
[ | [h:objectArrary = json.append('',rectangle)] | ||
</ | [h:eraseVBL(objectArrary)] | ||
</syntaxhighlight> | |||
[[Category:VBL Function]] | |||
|also= | |also= | ||
[[Introduction to Vision Blocking]], {{func|drawVBL}} | [[Introduction to Vision Blocking]], {{func|drawVBL}} | ||
}} | }} | ||
[[Category: | [[Category:Miscellaneous Function]] | ||
Latest revision as of 23:31, 9 February 2023
eraseVBL() Function
Note: This function can only be used in a Trusted Macro
• Introduced in version 1.3b89
Erases Wall Vision Blocking Layer (Wall 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)]