getViewArea: Difference between revisions

From RPTools Wiki
Jump to navigation Jump to search
No edit summary
m (Text replacement - "<source" to "<syntaxhighlight")
 
(7 intermediate revisions by 4 users not shown)
Line 3: Line 3:
|version=1.5.0
|version=1.5.0
|description=
|description=
Returns the limits of the visible area of the map window, given in either pixels or cell coordinates depending on the first parameter. The result is in a ";" delimited String as default or can be configured by setting the delimiter or using Json.
Returns the limits of the visible area of the map window, given in either map pixels or cell coordinates depending on the first parameter. The result is in a ";" delimited String as default or can be configured by setting the delimiter or using Json.


|usage=
|usage=
<source lang="mtmacro" line>
<syntaxhighlight lang="mtmacro" line>
getViewArea()
getViewArea()
getViewArea(pixels)
getViewArea(pixels)
getViewArea(pixels, delim)
getViewArea(pixels, delim)
</source>
</syntaxhighlight>


'''Parameters'''
'''Parameters'''
* {{code|pixels}} - if set to true (1) means the returned coordinates are measured in pixels. If set to false (0) the returned coordinates are measured in map cells. Defaults to {{code|true}}.
* {{code|pixels}} - if set to true (1) means the returned coordinates are measured in map pixels. If set to false (0) the returned coordinates are measured in map cells. Defaults to {{code|true}}.
* {{code|delim}} - if set to "json" means the returned coordinates are defined in JSON style. Otherwise a String property list is returning using {{code|delim}} as a delimiter. Defaults to {{code|;}}.
* {{code|delim}} - if set to "json" means the returned coordinates are defined in JSON style. Otherwise a String property list is returning using {{code|delim}} as a delimiter. Defaults to {{code|;}}.


|examples=
|examples=
Get the viewport dimensions of the current client:
Get the viewport dimensions of the current client:
<source lang="mtmacro" line>
<syntaxhighlight lang="mtmacro" line>
[r: getViewArea()] <!-- Default pixels -->
[r: getViewArea()] <!-- Default pixels -->
[r: getViewArea(0)] <!-- in Grid Cells -->
[r: getViewArea(0)] <!-- in Grid Cells -->
Line 26: Line 26:
[r: getViewArea(0, ",")] <!-- Cells as "," separated String properties: -->
[r: getViewArea(0, ",")] <!-- Cells as "," separated String properties: -->
[r: getViewArea(1, ";")] <!-- Pixels as ";" separated String properties: -->
[r: getViewArea(1, ";")] <!-- Pixels as ";" separated String properties: -->
</source>
</syntaxhighlight>


Output:
Output:
<source lang="mtmacro" line>
<syntaxhighlight lang="mtmacro" line>
offsetX=0; offsetY=0; width=886; height=616  
startX=0; startY=0; endX=886; endY=616  
offsetX=0; offsetY=0; width=17; height=12  
startX=0; startY=0; endX=17; endY=12  
offsetX=0; offsetY=0; width=886; height=616  
startX=0; startY=0; endX=886; endY=616  
{"offsetX":0,"offsetY":0,"width":886,"height":616}  
{"startX":0,"startY":0,"endX":886,"endY":616}  
{"offsetX":0,"offsetY":0,"width":886,"height":616}  
{"startX":0,"startY":0,"endX":886,"endY":616}  
offsetX=0, offsetY=0, width=886, height=616  
startX=0, startY=0, endX=886, endY=616  
offsetX=0; offsetY=0; width=886; height=616
startX=0; startY=0; endX=886; endY=616
</source>
</syntaxhighlight>


|also=
|also=

Latest revision as of 21:11, 14 March 2023

getViewArea() Function

Introduced in version 1.5.0
Returns the limits of the visible area of the map window, given in either map pixels or cell coordinates depending on the first parameter. The result is in a ";" delimited String as default or can be configured by setting the delimiter or using Json.

Usage

getViewArea()
getViewArea(pixels)
getViewArea(pixels, delim)

Parameters

  • pixels - if set to true (1) means the returned coordinates are measured in map pixels. If set to false (0) the returned coordinates are measured in map cells. Defaults to true.
  • delim - if set to "json" means the returned coordinates are defined in JSON style. Otherwise a String property list is returning using delim as a delimiter. Defaults to ;.

Examples

Get the viewport dimensions of the current client:
[r: getViewArea()] <!-- Default pixels -->
[r: getViewArea(0)] <!-- in Grid Cells -->
[r: getViewArea(1)] <!-- in Pixels -->
[r: getViewArea(0, "json")] <!-- Cells as JSON -->
[r: getViewArea(1, "json")] <!-- Pixels as JSON -->
[r: getViewArea(0, ",")] <!-- Cells as "," separated String properties: -->
[r: getViewArea(1, ";")] <!-- Pixels as ";" separated String properties: -->

Output:

startX=0; startY=0; endX=886; endY=616 
startX=0; startY=0; endX=17; endY=12 
startX=0; startY=0; endX=886; endY=616 
{"startX":0,"startY":0,"endX":886,"endY":616} 
{"startX":0,"startY":0,"endX":886,"endY":616} 
startX=0, startY=0, endX=886, endY=616 
startX=0; startY=0; endX=886; endY=616

See Also