js:MapTool.clientInfo: Difference between revisions
Jump to navigation
Jump to search
No edit summary |
mNo edit summary |
||
| Line 5: | Line 5: | ||
|name=clientInfo.faceEdge | |name=clientInfo.faceEdge | ||
|trusted=true | |trusted=true | ||
|version=1. | |version=1.10.0 | ||
|description= | |description= | ||
Returns {{code|true}} if tokens face the edge. | Returns {{code|true}} if tokens face the edge. | ||
| Line 22: | Line 22: | ||
|name=clientInfo.faceVertex | |name=clientInfo.faceVertex | ||
|trusted=true | |trusted=true | ||
|version=1. | |version=1.10.0 | ||
|description= | |description= | ||
Opposite of faceEdge | Opposite of faceEdge | ||
| Line 38: | Line 38: | ||
|name=clientInfo.portraitSize | |name=clientInfo.portraitSize | ||
|trusted=true | |trusted=true | ||
|version=1. | |version=1.10.0 | ||
|description= | |description= | ||
Returns the number of pixels used to display portraits | Returns the number of pixels used to display portraits | ||
| Line 55: | Line 55: | ||
|name=clientInfo.showStatSheet | |name=clientInfo.showStatSheet | ||
|trusted=true | |trusted=true | ||
|version=1. | |version=1.10.0 | ||
|description= | |description= | ||
Returns true if the player has show stat sheet selected in preferences. | Returns true if the player has show stat sheet selected in preferences. | ||
| Line 73: | Line 73: | ||
|name=clientInfo.version | |name=clientInfo.version | ||
|trusted=true | |trusted=true | ||
|version=1. | |version=1.10.0 | ||
|description= | |description= | ||
Version string of maptool. | Version string of maptool. | ||
| Line 89: | Line 89: | ||
|name=clientInfo.fullScreen | |name=clientInfo.fullScreen | ||
|trusted=true | |trusted=true | ||
|version=1. | |version=1.10.0 | ||
|description= | |description= | ||
Returns if the current frame is fullscreen. | Returns if the current frame is fullscreen. | ||
| Line 106: | Line 106: | ||
|name=clientInfo.timeInMs | |name=clientInfo.timeInMs | ||
|trusted=true | |trusted=true | ||
|version=1. | |version=1.10.0 | ||
|description= | |description= | ||
Returns the current time with ms precision. | Returns the current time with ms precision. | ||
| Line 123: | Line 123: | ||
|name=clientInfo.timeDate | |name=clientInfo.timeDate | ||
|trusted=true | |trusted=true | ||
|version=1. | |version=1.10.0 | ||
|description= | |description= | ||
Returns the current time and date as an opaque object. | Returns the current time and date as an opaque object. | ||
| Line 141: | Line 141: | ||
|name=clientInfo.libraryTokens | |name=clientInfo.libraryTokens | ||
|trusted=true | |trusted=true | ||
|version=1. | |version=1.10.0 | ||
|description= | |description= | ||
Returns a map of all library tokens. | Returns a map of all library tokens. | ||
| Line 158: | Line 158: | ||
|name=clientInfo.userDefinedFunctions | |name=clientInfo.userDefinedFunctions | ||
|trusted=true | |trusted=true | ||
|version=1. | |version=1.10.0 | ||
|description= | |description= | ||
Returns a list of user defined function aliases. | Returns a list of user defined function aliases. | ||
| Line 175: | Line 175: | ||
|name=clientInfo.getClientId | |name=clientInfo.getClientId | ||
|trusted=true | |trusted=true | ||
|version=1. | |version=1.10.0 | ||
|description= | |description= | ||
Returns the unique ID of the current client as a string. | Returns the unique ID of the current client as a string. | ||
Revision as of 20:36, 22 September 2021
This article describes a feature or macro function that is experimental and may be subject to change.
Within the javascript environment used by js.eval, MapTool.clientInfo gives information about the client and user settings.
clientInfo.faceEdge() Function
Note: This function can only be used in a Trusted Macro
• Introduced in version 1.10.0
Returns
true if tokens face the edge.Usage
MapTool.clientInfo.faceEdge();
Parameters
returntrueif tokens face the edge,falseotherwise.
clientInfo.faceVertex() Function
Note: This function can only be used in a Trusted Macro
• Introduced in version 1.10.0
Opposite of faceEdge
Usage
MapTool.clientInfo.faceVertex();
Parameters
returntrueif tokens face the vertex,falseotherwise.
clientInfo.portraitSize() Function
Note: This function can only be used in a Trusted Macro
• Introduced in version 1.10.0
Returns the number of pixels used to display portraits
Usage
MapTool.clientInfo.portraitSize();
Parameters
returnNumber of pixels high and wide a portrait is.
clientInfo.showStatSheet() Function
Note: This function can only be used in a Trusted Macro
• Introduced in version 1.10.0
Returns true if the player has show stat sheet selected in preferences.
Usage
MapTool.clientInfo.showStatSheet();
Parameters
returntrueif the stat sheet is show.
clientInfo.version() Function
Note: This function can only be used in a Trusted Macro
• Introduced in version 1.10.0
Version string of maptool.
Usage
MapTool.clientInfo.version();
Parameters
returnThe version information of MapTool, as a string.
clientInfo.fullScreen() Function
Note: This function can only be used in a Trusted Macro
• Introduced in version 1.10.0
Returns if the current frame is fullscreen.
Usage
MapTool.clientInfo.fullScreen();
Parameters
returntrueif the current frame is fullscreen.
clientInfo.timeInMs() Function
Note: This function can only be used in a Trusted Macro
• Introduced in version 1.10.0
Returns the current time with ms precision.
Usage
MapTool.clientInfo.timeInMs();
Parameters
returnSystem time in miliseconds as an integer.
clientInfo.timeDate() Function
Note: This function can only be used in a Trusted Macro
• Introduced in version 1.10.0
Returns the current time and date as an opaque object.
Just use
new Date() instead.Usage
MapTool.clientInfo.timeDate();
Parameters
returnSystem time as a java Date object. It can be converted to an integer or a string, but is otherwise opaque.
clientInfo.libraryTokens() Function
Note: This function can only be used in a Trusted Macro
• Introduced in version 1.10.0
Returns a map of all library tokens.
Usage
MapTool.clientInfo.libraryTokens();
Parameters
returnJavascript object mapping library token names to library versions.
clientInfo.userDefinedFunctions() Function
Note: This function can only be used in a Trusted Macro
• Introduced in version 1.10.0
Returns a list of user defined function aliases.
Usage
MapTool.clientInfo.userDefinedFunctions();
Parameters
returnA list of user defined function aliases.
clientInfo.getClientId() Function
Note: This function can only be used in a Trusted Macro
• Introduced in version 1.10.0
Returns the unique ID of the current client as a string.
Usage
MapTool.clientInfo.getClientId();
Parameters
returnCurrent client ID.