drawHillVBL: Difference between revisions

From RPTools Wiki
Jump to navigation Jump to search
No edit summary
No edit summary
Line 17: Line 17:
'''Parameters'''
'''Parameters'''
{{param|shapesList|A [[JSON Array]] of [[JSON Object|JSON objects]], one of the latter for each Hill VBL shape. See {{func|drawVBL}} for a complete description of possible shapes}}
{{param|shapesList|A [[JSON Array]] of [[JSON Object|JSON objects]], one of the latter for each Hill VBL shape. See {{func|drawVBL}} for a complete description of possible shapes}}
The shapes can be one of {{code|"Rectangle"}}, {{code|"Circle"}}, {{code|"Polygon"}} or {{code|"Cross"}}.
<br /><br />
''Example:''<source lang="mtmacro">
[h:polygon = "{'shape':'polygon','r':0,'close':1,'thickness':10,'points':[{'x':0,'y':0},{'x':200,'y':200},{'x':150,'y':10}]}"] </source><br />





Revision as of 07:15, 26 January 2022

drawHillVBL() Function

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

Introduced in version 1.11.0
Draws Hill Vision Blocking Layer (Hill VBL) shapes.

Usage

drawHillVBL(shapesList)

This function works EXACTLY the same as eraseHillVBL() with the ONLY difference that drawHillVBL draws the shapes on the Hill Vision Blocking Layer and eraseHillVBL() erases them.


Parameters

Example

This example builds an array of the object from the above examples and then feeds that array into the drawHillVBL function
[h:rectangle	= "{'shape':'rectangle','x':50,'y':50,'w':100,'h':200,'r':45,'fill':1,'thickness':1,'scale':0}"]
[h:cross	= "{'shape':'cross','x':-50,'y':-50,'w':50,'h':100,'r':30,'fill':1,'thickness':1,'scale':2}"]
[h:circle	= "{'shape':'circle', 'x':50, 'y':100, 'radius':200, 'thickness':3, 'fill':0, 'sides':12,'r':45}"]
[h:polygon	= "{'shape':'polygon','r':0,'close':1,'thickness':10,'points':[{'x':0,'y':0},{'x':200,'y':200},{'x':150,'y':10}]}"] 
[h:objectArrary	= json.append('',rectangle, cross, circle, polygon)]
[h:drawHillVBL(objectArrary)]

results in:

TODO

See Also