eraseVBL: Difference between revisions

From RPTools Wiki
Jump to navigation Jump to search
(Adding description, link to other functions)
(Modified usage, added link)
Line 1: Line 1:
{{stub|Empty article at the moment.}}
{{stub|Needs a proper description.<br />
Parameters need to be defined.<br />
Lacks examples.}}
{{MacroFunction
{{MacroFunction
|name=eraseVBL
|name=eraseVBL
Line 10: Line 12:
|usage=
|usage=
<source lang="mtmacro" line>
<source lang="mtmacro" line>
eraseVBL(param1, param2)
eraseVBL(???)
</source>
</source>


'''Parameters'''
{{note|Consist of [[JSON Object|JSON objects]] nested in a [[JSON Array]]. The objects' keys seem to be "shape" ''("polygon", "rectangle", "circle", "cross")'', "r" ''(???)'', "fill" ''(boolean)'', "close" ''(???)'', "thickness" ''(pixels)'', "points" ''(object)'', "x" ''(pixels)'', "y" ''(pixels)'', "w" ''(pixels)'', "h" ''(pixels)'', "scale" ''(???)'', "radius" ''(pixels)'', "sides" ''(integer)'', "facing" ''(degrees from ??? rotating ???)'', "rx" ''(pixels)'', "ry" ''(pixels)''.}}
|example=
|example=
This example doesn't really do anything.
This example doesn't really do anything.
Line 25: Line 29:


|also=
|also=
{{func|drawVBL}}
[[Introduction to Vision Blocking]], {{func|drawVBL}}
}}
}}
[[Category:Token Function]]
[[Category:Token Function]]

Revision as of 14:32, 8 April 2013

 This article is a stub, you can help the RPTools Wiki project by contributing content to expand this article.
 This article needs: Needs a proper description.
Parameters need to be defined.
Lacks examples.

eraseVBL() Function

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

Introduced in version 1.3b89
This function erases a VBL shape from the supplied coordinates.

Usage

eraseVBL(???)

Parameters

Consist of JSON objects nested in a JSON Array. The objects' keys seem to be "shape" ("polygon", "rectangle", "circle", "cross"), "r" (???), "fill" (boolean), "close" (???), "thickness" (pixels), "points" (object), "x" (pixels), "y" (pixels), "w" (pixels), "h" (pixels), "scale" (???), "radius" (pixels), "sides" (integer), "facing" (degrees from ??? rotating ???), "rx" (pixels), "ry" (pixels).

Example

This example doesn't really do anything.
[h: exampleVariable = "a,b,c"]
[r: exampleFunction(exampleVariable, reverse)]

Returns:

c,b,a

See Also