getInfo: Difference between revisions
Jump to navigation
Jump to search
m (Formatting; add "Themes" category) |
|||
(7 intermediate revisions by one other user not shown) | |||
Line 4: | Line 4: | ||
|description= | |description= | ||
Returns a [[JSON Object]] with lots of information about a specified topic. | Returns a [[JSON Object]] with lots of information about a specified topic. | ||
[[Category:MapTool]] | |||
|usage= | |usage= | ||
<syntaxhighlight lang="mtmacro" line> | <syntaxhighlight lang="mtmacro" line> | ||
Line 10: | Line 10: | ||
</syntaxhighlight > | </syntaxhighlight > | ||
'''Parameter''' | '''Parameter''' | ||
{{param|topic|A string specifying the topic of the retrieved information. Can be {{code|"map"}}, {{code|"client"}}, {{code|"server"}}, {{code|"theme"}} or {{code|" | {{param|topic|A string specifying the topic of the retrieved information. Can be {{code|"map"}}, {{code|"client"}}, {{code|"server"}}, {{code|"theme"}}, {{code|"campaign"}}, {{code|"debug"}}, or {{code|"zone"}} (older version of {{code|"map"}}).}} | ||
|examples= | |examples= | ||
Examples of the different options. | Examples of the different options. | ||
===Retrieve {{code|map}} Information=== | === Retrieve {{code|map}} Information === | ||
<syntaxhighlight lang="mtmacro" line> | <syntaxhighlight lang="mtmacro" line> | ||
Line 28: | Line 28: | ||
<syntaxhighlight lang="json"> | <syntaxhighlight lang="json"> | ||
{ | { | ||
"name": "Grasslands" | "name":"Grasslands" | ||
"display name": " | "display name":"Grasslands" | ||
"image x scale": 1 | "image x scale":1.0 | ||
"image y scale": 1 | "image y scale":1.0 | ||
"player visible": 1 | "player visible":1 | ||
"id": " | "id":"5A405229C16844869018F80F98DBF496" | ||
"creation time": | "creation time":1702257111841 | ||
"width": 0 | "width":0 | ||
"height": 0 | "height":0 | ||
"largest Z order": | "largest Z order":0 | ||
"vision type": "OFF" | "vision type":"OFF" | ||
"grid": | "vision distance":1000 | ||
"type": "Square" | "lighting style":"OVERTOP" | ||
"color": "ff000000" | "has fog":false | ||
"units per cell": 5 | "ai rounding":"NONE" | ||
"cell height": 100 | "grid":{ | ||
"cell width": 100 | "type":"Square" | ||
"cell offset width": 0 | "color":"ff000000" | ||
"cell offset height": 0 | "units per cell":5.0 | ||
"size": 100 | "cell height":100.0 | ||
"x offset": 0 | "cell width":100.0 | ||
"y offset": 0 | "cell offset width":0.0 | ||
"second dimension": 0 | "cell offset height":0.0 | ||
"size":100 | |||
"x offset":0 | |||
"y offset":0 | |||
"second dimension":0.0 | |||
} | } | ||
"background paint":"asset://c93660c09e3d3f9aff04df49a6c594b4" | |||
"fog paint":"#ff000000" | |||
"map asset":null | |||
} | } | ||
</syntaxhighlight> | </syntaxhighlight> | ||
===Retrieve {{code|client}} Information=== | === Retrieve {{code|client}} Information === | ||
<syntaxhighlight lang="mtmacro" line> | <syntaxhighlight lang="mtmacro" line> | ||
Line 131: | Line 138: | ||
The {{code|getInfo("client")}} function returns the names of all Lib: tokens. As a bonus if the Lib: token has a property called {{code|libversion}}, the value of this property will be reported as the value. | The {{code|getInfo("client")}} function returns the names of all Lib: tokens. As a bonus if the Lib: token has a property called {{code|libversion}}, the value of this property will be reported as the value. | ||
===Retrieve {{code|server}} Information=== | === Retrieve {{code|server}} Information === | ||
<syntaxhighlight lang="mtmacro" line> | <syntaxhighlight lang="mtmacro" line> | ||
Line 171: | Line 178: | ||
</syntaxhighlight> | </syntaxhighlight> | ||
===Retrieve {{code|campaign}} Information=== | === Retrieve {{code|campaign}} Information === | ||
<syntaxhighlight lang="mtmacro" line> | <syntaxhighlight lang="mtmacro" line> | ||
Line 179: | Line 186: | ||
</pre> | </pre> | ||
</syntaxhighlight> | </syntaxhighlight> | ||
Sample output: | Sample output: | ||
Line 456: | Line 462: | ||
</syntaxhighlight> | </syntaxhighlight> | ||
=== Retrieve {{code|theme}} Information === | |||
===Retrieve {{code|theme}} Information=== | |||
Colors are returned as ARGB hex values. The key names are for the various GUI elements. See the [[Themes for MapTool]] page for more information about themes and the TinyLaF theme editor. | Colors are returned as ARGB hex values. The key names are for the various GUI elements. See the [[Themes for MapTool]] page for more information about themes and the TinyLaF theme editor. | ||
[[Category:Themes]] | |||
<syntaxhighlight lang="mtmacro" line> | <syntaxhighlight lang="mtmacro" line> | ||
<!-- print the JSON Object about the campaign to the chat window --> | <!-- print the JSON Object about the campaign to the chat window --> | ||
Line 481: | Line 487: | ||
"CheckBox.disabledText": "ff8f8e8b", | "CheckBox.disabledText": "ff8f8e8b", | ||
... plus 300 more lines. | ... plus 300 more lines. | ||
} | |||
</syntaxhighlight> | |||
=== Retrieve {{code|debug}} Information === | |||
Retrieve debug information, including MapTool version, Java settings, language setting, and operating system. | |||
<syntaxhighlight lang="mtmacro" line> | |||
<!-- print the JSON Object with debug info to the chat window --> | |||
<pre> | |||
[r: json.indent(getInfo("debug"), 2)] | |||
</pre> | |||
</syntaxhighlight> | |||
<syntaxhighlight lang="json"> | |||
{ | |||
"maptool":{"version":"1.13.1","max mem avail":"16,312","max mem used":"251,658,240"} | |||
"java":{"vendor":"Eclipse Adoptium" | |||
"home":"C:\\Users\\usenrame\\AppData\\Local\\MapTool\\runtime" | |||
"version":"17.0.1"} | |||
"locale":{"country":"United States","language":"English"} | |||
"locale":"English (United States)" | |||
"variant":""} | |||
"os":{"name":"Windows 10","version":"10.0","arch":"amd64" | |||
} | |||
</syntaxhighlight> | |||
=== Retrieve {{code|zone}} Information === | |||
Retrieve information about the current map. | |||
<syntaxhighlight lang="mtmacro" line> | |||
<!-- print the JSON Object with zone info to the chat window --> | |||
<pre> | |||
[r: json.indent(getInfo("zone"), 2)] | |||
</pre> | |||
</syntaxhighlight> | |||
<syntaxhighlight lang="json"> | |||
{ | |||
"name":"Grasslands","display name":"Grasslands" | |||
"image x scale":1.0 | |||
"image y scale":1.0 | |||
"player visible":1 | |||
"id":"AB238DF229604240BC1FB33A3BB733CB" | |||
"creation time":1702182845421 | |||
"width":0 | |||
"height":0 | |||
"largest Z order":0 | |||
"vision type":"OFF" | |||
"vision distance":1000 | |||
"grid":{"type":"Square","color":"ff000000"} | |||
"units per cell":5.0 | |||
"cell height":100.0 | |||
"cell width":100.0 | |||
"cell offset width":0.0 | |||
"cell offset height":0.0 | |||
"size":100 | |||
"x offset":0 | |||
"y offset":0 | |||
"second dimension":0.0 | |||
} | } | ||
</syntaxhighlight> | </syntaxhighlight> | ||
Line 501: | Line 568: | ||
* '''1.11.0''' - Added "theme" option to retrieve the color information from the currently loaded theme. | * '''1.11.0''' - Added "theme" option to retrieve the color information from the currently loaded theme. | ||
* '''1.12.0''' - Added "userLanguage" to the client info. This will allow add-ons and macros to localize according to the client's UI. | * '''1.12.0''' - Added "userLanguage" to the client info. This will allow add-ons and macros to localize according to the client's UI. | ||
* '''1.14.0''' - Added "lighting style", "has fog", "ai rounding", "background paint", "fog paint", "map asset" to zone info. | |||
}} | }} | ||
[[Category:Miscellaneous Function]] | [[Category:Miscellaneous Function]] |
Revision as of 21:24, 23 February 2024
getInfo() Function
• Introduced in version 1.3b69
Returns a JSON Object with lots of information about a specified topic.
Usage
getInfo(topic)
Parameter
topic
- A string specifying the topic of the retrieved information. Can be"map"
,"client"
,"server"
,"theme"
,"campaign"
,"debug"
, or"zone"
(older version of"map"
).
Examples
Examples of the different options.
Retrieve
Retrieve
Retrieve
Retrieve
Retrieve
Retrieve
Retrieve
Retrieve map
Information
<!-- print the JSON Object about the current map to the chat window -->
[h:themeInfo = getInfo("map")]
<pre>
[r: json.indent(themeInfo, 2)]
</pre>
Sample output:
{
"name":"Grasslands"
"display name":"Grasslands"
"image x scale":1.0
"image y scale":1.0
"player visible":1
"id":"5A405229C16844869018F80F98DBF496"
"creation time":1702257111841
"width":0
"height":0
"largest Z order":0
"vision type":"OFF"
"vision distance":1000
"lighting style":"OVERTOP"
"has fog":false
"ai rounding":"NONE"
"grid":{
"type":"Square"
"color":"ff000000"
"units per cell":5.0
"cell height":100.0
"cell width":100.0
"cell offset width":0.0
"cell offset height":0.0
"size":100
"x offset":0
"y offset":0
"second dimension":0.0
}
"background paint":"asset://c93660c09e3d3f9aff04df49a6c594b4"
"fog paint":"#ff000000"
"map asset":null
}
Retrieve client
Information
<!-- print the JSON Object about client information to the chat window -->
<pre>
[r: json.indent(getInfo("client"), 4)]
</pre>
Sample output:
{
"face edge": 1,
"face vertex": 1,
"portrait size": 175,
"show portrait": true,
"show stat sheet": true,
"file sync directory": "",
"show avatar in chat": true,
"suppress tooltips for macroLinks": false,
"use tooltips for inline rolls": false,
"version": "1.12.0",
"isFullScreen": 0,
"timeInMs": 1659941691370,
"timeDate": "2022-08-08 08:54:51",
"isoTimeDate": "2022-08-08T08:54:51.3704561+02:00",
"isHosting": false,
"isPersonalServer": true,
"userLanguage": "en",
"dialogs": {
"Dialog Name": {
"width": 650,
"height": 535,
"temporary": 1,
"title": "Title of the dialog",
"visible": 1,
"noframe": 0,
"input": 1,
"closebutton": 0,
"html5": 1,
"value": ""
}
},
"frames": {
"Frame Name": {
"width": 650,
"height": 535,
"temporary": 1,
"title": "Title of the frame",
"visible": 1,
"noframe": 0,
"input": 1,
"closebutton": 0,
"html5": 1,
"value": ""
}
},
"overlays": {
"Framework Macros": {
"name": "Framework Macros",
"zorder": 4,
"visible": 1
}
},
"library tokens": {
"Name": "libVersion"
},
"user defined functions": {
"function Name": "MacroName@Library"
},
"client id": "062b5d31-5569-412f-8f42-21faccbba44d"
}
Note:
The getInfo("client")
function returns the names of all Lib: tokens. As a bonus if the Lib: token has a property called libversion
, the value of this property will be reported as the value.
Retrieve server
Information
<!-- print the JSON Object about server information to the chat window -->
<pre>
[r: json.indent(getInfo("server"), 4)]
</pre>
Sample output:
{
"GM reveals vision for unowned tokens": 0,
"restricted impersonation": 0,
"tooltips for default roll format": 1,
"movement locked": 0,
"gm": ["GM"],
"hide map select ui": 0,
"disable player asset panel": 0,
"movement metric": "ONE_TWO_ONE",
"hosting server": 1,
"personal server": 1,
"players can reveal": 1,
"players receive campaign macros": 1,
"auto reveal on movement": 1,
"strict token management": 1,
"using ai": 1,
"vbl blocks movement": 1,
"timeDate": "2019-09-22 18:09:02",
"timeInMs": 1569197342110,
"token editor locked": 0,
"individual views": 1,
"individual fow": 0,
"useWebRTC": 0,
"usePasswordFile": 1,
"server name": "Z is for Zombie",
"port number": 51234
}
Retrieve campaign
Information
<!-- print the JSON Object about the campaign to the chat window -->
<pre>
[r: json.indent(getInfo("campaign"), 2)]
</pre>
Sample output:
{
"tables": [],
"initiative owner permissions": 1,
"id": "C0A8001E7F7E199B0B0000008008001E",
"sight": {
"Darkvision": {
"distance": 0,
"arc": 0,
"shape": "CIRCLE",
"type": 0,
"multiplier": 1 },
"Normal Vision - Short Range": {
"distance": 0,
"arc": 0,
"shape": "CIRCLE",
"type": 0,
"multiplier": 1 },
"Normal": {
"distance": 0,
"arc": 0,
"shape": "CIRCLE",
"type": 0,
"multiplier": 1 },
"Square Vision": {
"distance": 0,
"arc": 0,
"shape": "SQUARE",
"type": 0,
"multiplier": 1 },
"Lowlight": {
"distance": 0,
"arc": 0,
"shape": "CIRCLE",
"type": 0,
"multiplier": 2 },
"Conic Vision": {
"distance": 120,
"arc": 120,
"shape": "CONE",
"type": 0,
"multiplier": 1 }
},
"initiative movement locked": 1,
"light sources": {
"D20": [
{
"name": "Lantern, Hooded - 30",
"light segments": [
{
"GM": false,
"arcAngle": 360,
"facingOffset": 0,
"ownerOnly": false,
"paint": null,
"radius": 30,
"shape": null },
{
"GM": false,
"arcAngle": 360,
"facingOffset": 0,
"ownerOnly": false,
"paint": {"color":1677721600},
"radius": 60,
"shape": null } ],
"type": "NORMAL",
"max range": 60 },
{
"name": "Candle - 5",
"light segments": [
{
"GM": false,
"arcAngle": 360,
"facingOffset": 0,
"ownerOnly": false,
"paint": null,
"radius": 5,
"shape": null },
{
"GM": false,
"arcAngle": 360,
"facingOffset": 0,
"ownerOnly": false,
"paint": {"color":1677721600},
"radius": 10,
"shape": null } ],
"type": "NORMAL",
"max range": 10 },
{
"name": "Lamp - 15",
"light segments": [
{
"GM": false,
"arcAngle": 360,
"facingOffset": 0,
"ownerOnly": false,
"paint": null,
"radius": 15,
"shape": null },
{
"GM": false,
"arcAngle": 360,
"facingOffset": 0,
"ownerOnly": false,
"paint": {"color":1677721600},
"radius": 30,
"shape": null } ],
"type": "NORMAL",
"max range": 30 },
{
"name": "Torch - 20",
"light segments": [
{
"GM": false,
"arcAngle": 360,
"facingOffset": 0,
"ownerOnly": false,
"paint": null,
"radius": 20,
"shape": null },
{
"GM": false,
"arcAngle": 360,
"facingOffset": 0,
"ownerOnly": false,
"paint": {"color":1677721600},
"radius": 40,
"shape": null } ],
"type": "NORMAL",
"max range": 40 },
{
"name": "Sunrod - 30",
"light segments": [
{
"GM": false,
"arcAngle": 360,
"facingOffset": 0,
"ownerOnly": false,
"paint": null,
"radius": 30,
"shape": null },
{
"GM": false,
"arcAngle": 360,
"facingOffset": 0,
"ownerOnly": false,
"paint": {"color":1677721600},
"radius": 60,
"shape": null } ],
"type": "NORMAL",
"max range": 60 },
{
"name": "Everburning - 20",
"light segments": [
{
"GM": false,
"arcAngle": 360,
"facingOffset": 0,
"ownerOnly": false,
"paint": null,
"radius": 20,
"shape": null },
{
"GM": false,
"arcAngle": 360,
"facingOffset": 0,
"ownerOnly": false,
"paint": {"color":1677721600},
"radius": 40,
"shape": null } ],
"type": "NORMAL",
"max range": 40 } ],
"Generic": [
{
"name": "5",
"light segments": [
{
"GM": false,
"arcAngle": 360,
"facingOffset": 0,
"ownerOnly": false,
"paint": null,
"radius": 5,
"shape": null } ],
"type": "NORMAL",
"max range": 5 },
{
"name": "40",
"light segments": [
{
"GM": false,
"arcAngle": 360,
"facingOffset": 0,
"ownerOnly": false,
"paint": null,
"radius": 40,
"shape": null } ],
"type": "NORMAL",
"max range": 40 },
{
"name": "20",
"light segments": [
{
"GM": false,
"arcAngle": 360,
"facingOffset": 0,
"ownerOnly": false,
"paint": null,
"radius": 20,
"shape": null } ],
"type": "NORMAL",
"max range": 20 },
{
"name": "60",
"light segments": [
{
"GM": false,
"arcAngle": 360,
"facingOffset": 0,
"ownerOnly": false,
"paint": null,
"radius": 60,
"shape": null } ],
"type": "NORMAL",
"max range": 60 },
{
"name": "15",
"light segments": [
{
"GM": false,
"arcAngle": 360,
"facingOffset": 0,
"ownerOnly": false,
"paint": null,
"radius": 15,
"shape": null } ],
"type": "NORMAL",
"max range": 15 },
{
"name": "30",
"light segments": [
{
"GM": false,
"arcAngle": 360,
"facingOffset": 0,
"ownerOnly": false,
"paint": null,
"radius": 30,
"shape": null } ],
"type": "NORMAL",
"max range": 30 } ] },
"bars": {
"no group": [
{
"increment": 0,
"side": "TOP",
"name": "Health" } ] },
"states": {
"no group": [
"Incapacitated",
"Disabled",
"Other2",
"Other",
"Other3",
"Prone",
"Hidden",
"Dead",
"Other4" ] },
"remote repository": [],
"zones": {
"Grasslands": "C0A8001E7E7F199B0C0000008008001E" }
}
Retrieve theme
Information
Colors are returned as ARGB hex values. The key names are for the various GUI elements. See the Themes for MapTool page for more information about themes and the TinyLaF theme editor.
<!-- print the JSON Object about the campaign to the chat window -->
<pre>
[r: json.indent(getInfo("theme"), 2)]
</pre>
{
"Button.background": "fff1f1f1",
"Button.darkShadow": "ff666666",
"Button.disabledText": "ff8f8e8b",
"Button.focus": "ff9999cc",
"Button.foreground": "ff000000",
"Button.highlight": "ffffffff",
"Button.light": "ffffffff",
"Button.select": "ff999999",
"Button.shadow": "ff999999",
"CheckBox.background": "ffefefef",
"CheckBox.disabledText": "ff8f8e8b",
... plus 300 more lines.
}
Retrieve debug
Information
Retrieve debug information, including MapTool version, Java settings, language setting, and operating system.
<!-- print the JSON Object with debug info to the chat window -->
<pre>
[r: json.indent(getInfo("debug"), 2)]
</pre>
{
"maptool":{"version":"1.13.1","max mem avail":"16,312","max mem used":"251,658,240"}
"java":{"vendor":"Eclipse Adoptium"
"home":"C:\\Users\\usenrame\\AppData\\Local\\MapTool\\runtime"
"version":"17.0.1"}
"locale":{"country":"United States","language":"English"}
"locale":"English (United States)"
"variant":""}
"os":{"name":"Windows 10","version":"10.0","arch":"amd64"
}
Retrieve zone
Information
Retrieve information about the current map.
<!-- print the JSON Object with zone info to the chat window -->
<pre>
[r: json.indent(getInfo("zone"), 2)]
</pre>
{
"name":"Grasslands","display name":"Grasslands"
"image x scale":1.0
"image y scale":1.0
"player visible":1
"id":"AB238DF229604240BC1FB33A3BB733CB"
"creation time":1702182845421
"width":0
"height":0
"largest Z order":0
"vision type":"OFF"
"vision distance":1000
"grid":{"type":"Square","color":"ff000000"}
"units per cell":5.0
"cell height":100.0
"cell width":100.0
"cell offset width":0.0
"cell offset height":0.0
"size":100
"x offset":0
"y offset":0
"second dimension":0.0
}
Version Changes
- 1.3b70 - Added "
campaign"
option fortopic
- 1.3b76 - Added values
"timeInMS"
and"timeDate"
to bothclient
andserver
return values - 1.3b90 - Added value
"gm"
toserver
return value that holds an array of logged in game masters - 1.5.4 - Added values
"auto reveal on movement"
and"individual fow"
toserver
return values - 1.5.5 - Added values
"GM reveals vision for unowned tokens"
and"hosting server"
toserver
return values - 1.5.7 - Added prefs setting
"file sync directory"
and"isoTimeDate"
toclient
return values - 1.5.9 - Removed
"initiative owner permissions "
fromserver
return values. Still incampaign
info. - 1.6.0 - Added
"using ai"
and"vbl blocks movment"
toserver
return values. - 1.7.0 - Added macro location information to
"user defined functions"
portion ofclient
info - 1.8.0 - Added additional client preferences to
client
info, and"personal server"
indicator toserver
info - 1.9.0 - Map vision type returned will be upper case
OFF
,"NIGHT"
orDAY
. Map display name will also be returned for map parameters. - 1.11.0 - Added
useWebRTC
,usePasswordFile
,server name
andport number
toserver
results. - 1.11.0 - Added "theme" option to retrieve the color information from the currently loaded theme.
- 1.12.0 - Added "userLanguage" to the client info. This will allow add-ons and macros to localize according to the client's UI.
- 1.14.0 - Added "lighting style", "has fog", "ai rounding", "background paint", "fog paint", "map asset" to zone info.