getHillVBL: Difference between revisions

From RPTools Wiki
Jump to navigation Jump to search
(Created page with "{{stub}} {{MacroFunction |name=getHillVBL |proposed=false |trusted=true |version=1.11.0 |description= Gets the Hill Vision Blocking Layer (Hill VBL) shapes for the area specif...")
 
m (Text replacement - "source>" to "syntaxhighlight>")
 
(3 intermediate revisions by 2 users not shown)
Line 9: Line 9:


|usage=
|usage=
<source lang="mtmacro" line>
<syntaxhighlight lang="mtmacro" line>
getHillVBL(shape)
getHillVBL(shape)
getHillVBL(shape,format)
getHillVBL(shape,format)
</source>
</syntaxhighlight>


This function retrieves the Hill VBL found in the given shape(s).
This function retrieves the Hill VBL found in the given shape(s).
Line 22: Line 22:


|examples=
|examples=
<source lang="mtmacro">
<syntaxhighlight lang="mtmacro">
[h:rectangle = '{"shape":"rectangle","x":50,"y":50,"w":100,"h":200,"r":45,"fill":1,"thickness":1,"scale":0}']
[h:rectangle = '{"shape":"rectangle","x":50,"y":50,"w":100,"h":200,"r":45,"fill":1,"thickness":1,"scale":0}']
[r:vblData  = getHillVBL(rectangle , 0)]
[r:vblData  = getHillVBL(rectangle , 0)]
</source><br />
</syntaxhighlight><br />


|also=
|also=

Latest revision as of 18:00, 14 March 2023

 This article is a stub, you can help the RPTools Wiki project by contributing content to expand this article.

getHillVBL() Function

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

Introduced in version 1.11.0
Gets the Hill Vision Blocking Layer (Hill VBL) shapes for the area specified in the shape parameter.

Usage

getHillVBL(shape)
getHillVBL(shape,format)

This function retrieves the Hill VBL found in the given shape(s).

Parameters

  • shape - A JSON object, or an array of JSON objects, as described in drawVBL(). If an array, gets all the Hill VBL within all provided shapes, otherwise just the Hill VBL in the single provided shape.
  • format - OPTIONAL Boolean. Returns a JSON object if false(0), or a JSON array of coordinates if true(1). In either case, the returned shape covers the Hill VBL found in the area. Defaults to false(0)

Examples

[h:rectangle = '{"shape":"rectangle","x":50,"y":50,"w":100,"h":200,"r":45,"fill":1,"thickness":1,"scale":0}']
[r:vblData   = getHillVBL(rectangle , 0)]

See Also