js:MapTool.clientInfo: Difference between revisions
Jump to navigation
Jump to search
mNo edit summary |
No edit summary |
||
| (3 intermediate revisions by 2 users not shown) | |||
| Line 10: | Line 10: | ||
|usage= | |usage= | ||
< | <syntaxhighlight lang="javascript" line> | ||
MapTool.clientInfo.faceEdge(); | MapTool.clientInfo.faceEdge(); | ||
</ | </syntaxhighlight> | ||
'''Parameters''' | '''Parameters''' | ||
| Line 27: | Line 27: | ||
|usage= | |usage= | ||
< | <syntaxhighlight lang="javascript" line> | ||
MapTool.clientInfo.faceVertex(); | MapTool.clientInfo.faceVertex(); | ||
</ | </syntaxhighlight> | ||
'''Parameters''' | '''Parameters''' | ||
| Line 43: | Line 43: | ||
|usage= | |usage= | ||
< | <syntaxhighlight lang="javascript" line> | ||
MapTool.clientInfo.portraitSize(); | MapTool.clientInfo.portraitSize(); | ||
</ | </syntaxhighlight> | ||
'''Parameters''' | '''Parameters''' | ||
| Line 60: | Line 60: | ||
|usage= | |usage= | ||
< | <syntaxhighlight lang="javascript" line> | ||
MapTool.clientInfo.showStatSheet(); | MapTool.clientInfo.showStatSheet(); | ||
</ | </syntaxhighlight> | ||
'''Parameters''' | '''Parameters''' | ||
| Line 78: | Line 78: | ||
|usage= | |usage= | ||
< | <syntaxhighlight lang="javascript" line> | ||
MapTool.clientInfo.version(); | MapTool.clientInfo.version(); | ||
</ | </syntaxhighlight> | ||
'''Parameters''' | '''Parameters''' | ||
| Line 94: | Line 94: | ||
|usage= | |usage= | ||
< | <syntaxhighlight lang="javascript" line> | ||
MapTool.clientInfo.fullScreen(); | MapTool.clientInfo.fullScreen(); | ||
</ | </syntaxhighlight> | ||
'''Parameters''' | '''Parameters''' | ||
| Line 111: | Line 111: | ||
|usage= | |usage= | ||
< | <syntaxhighlight lang="javascript" line> | ||
MapTool.clientInfo.timeInMs(); | MapTool.clientInfo.timeInMs(); | ||
</ | </syntaxhighlight> | ||
'''Parameters''' | '''Parameters''' | ||
| Line 129: | Line 129: | ||
|usage= | |usage= | ||
< | <syntaxhighlight lang="javascript" line> | ||
MapTool.clientInfo.timeDate(); | MapTool.clientInfo.timeDate(); | ||
</ | </syntaxhighlight> | ||
'''Parameters''' | '''Parameters''' | ||
| Line 146: | Line 146: | ||
|usage= | |usage= | ||
< | <syntaxhighlight lang="javascript" line> | ||
MapTool.clientInfo.libraryTokens(); | MapTool.clientInfo.libraryTokens(); | ||
</ | </syntaxhighlight> | ||
'''Parameters''' | '''Parameters''' | ||
| Line 163: | Line 163: | ||
|usage= | |usage= | ||
< | <syntaxhighlight lang="javascript" line> | ||
MapTool.clientInfo.userDefinedFunctions(); | MapTool.clientInfo.userDefinedFunctions(); | ||
</ | </syntaxhighlight> | ||
'''Parameters''' | '''Parameters''' | ||
| Line 180: | Line 180: | ||
|usage= | |usage= | ||
< | <syntaxhighlight lang="javascript" line> | ||
MapTool.clientInfo.clientId(); | MapTool.clientInfo.clientId(); | ||
</ | </syntaxhighlight> | ||
'''Parameters''' | '''Parameters''' | ||
Latest revision as of 23:59, 15 March 2023
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.clientId();
Parameters
returnCurrent client ID.