getViewCenter: Difference between revisions

From RPTools Wiki
Jump to navigation Jump to search
mNo edit summary
m (Text replacement - "<source" to "<syntaxhighlight")
 
(3 intermediate revisions by 2 users not shown)
Line 6: Line 6:


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


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


Output:
Output:
<source lang="mtmacro" line>
<syntaxhighlight lang="mtmacro" line>
centerX=646; centerY=319;
centerX=646; centerY=319;
centerX=14; centerY=7;
centerX=14; centerY=7;
Line 37: Line 37:
centerX=14, centerY=7;
centerX=14, centerY=7;
centerX=646; centerY=319,
centerX=646; centerY=319,
</source>
</syntaxhighlight>


|also=
|also=

Latest revision as of 21:11, 14 March 2023

getViewCenter() Function

Introduced in version 1.5.4
Returns the center 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

getViewCenter()
getViewCenter(pixels)
getViewCenter(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 center of the view of the current client:
[r: getViewCenter()] <!-- Default pixels -->
[r: getViewCenter(0)] <!-- in Grid Cells -->
[r: getViewCenter(1)] <!-- in Pixels -->
[r: getViewCenter(0, "json")] <!-- Cells as JSON -->
[r: getViewCenter(1, "json")] <!-- Pixels as JSON -->
[r: getViewCenter(0, ",")] <!-- Cells as "," separated String properties: -->
[r: getViewCenter(1, ";")] <!-- Pixels as ";" separated String properties: -->

Output:

centerX=646; centerY=319;
centerX=14; centerY=7;
centerX=646; centerY=319;
{"centerX":14,"centerY":7} 
{"centerX":646,"centerY":319} 
centerX=14, centerY=7;
centerX=646; centerY=319,

See Also